Skip to content
Osoian Marcel edited this page Apr 10, 2022 · 8 revisions

node-simple-ipc

Table of contents

References

Enumerations

Classes

Interfaces

Type aliases

Functions

References

default

Renames and re-exports NodeSimpleIpc

Type aliases

EventHandler

Ƭ EventHandler<T>: (data: T) => void

Type parameters

Name Type
T unknown

Type declaration

▸ (data): void

Parameters
Name Type
data T
Returns

void

Defined in

src/types/node-simple-ipc.ts:19


IpcHandler

Ƭ IpcHandler<I, O>: (i: I) => O

Type parameters

Name Type
I unknown
O unknown

Type declaration

▸ (i): O

Parameters
Name Type
i I
Returns

O

Defined in

src/types/node-simple-ipc.ts:17


RemoveHandler

Ƭ RemoveHandler: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/types/node-simple-ipc.ts:21

Functions

assertValidIpcHandler

assertValidIpcHandler(handlerFn): handlerFn is IpcHandler<unknown, unknown>

Parameters

Name Type
handlerFn unknown

Returns

handlerFn is IpcHandler<unknown, unknown>

Defined in

src/utils/validation.ts:17


assertValidIpcName

assertValidIpcName(name): name is string

Parameters

Name Type
name unknown

Returns

name is string

Defined in

src/utils/validation.ts:9


isIpcEvent

isIpcEvent(data): data is IpcEvent<unknown>

Parameters

Name Type
data unknown

Returns

data is IpcEvent<unknown>

Defined in

src/utils/validation.ts:57


isIpcInput

isIpcInput(data): data is IpcInput<unknown>

Parameters

Name Type
data unknown

Returns

data is IpcInput<unknown>

Defined in

src/utils/validation.ts:27


isIpcOutput

isIpcOutput(data): data is IpcOutput<unknown>

Parameters

Name Type
data unknown

Returns

data is IpcOutput<unknown>

Defined in

src/utils/validation.ts:42


serializeError

serializeError(err): SerializedError

Parameters

Name Type
err unknown

Returns

SerializedError

Defined in

src/utils/serialize-error.ts:3


uniqueId

uniqueId(): string

Returns a unique id.

Returns

string

Next unique id.

Defined in

src/utils/unique-id.ts:8