Class Channel

Wraps a protocol definition and a communication port into a properly typed communication channel.

Index

Methods

_createRequestHandler _createSender destroy new rx tx

Methods

_createRequestHandler

_createRequestHandler(
key: string,
val: MessageCodecs<unknown, unknown>,
): (handler: (req: unknown) => Promise<unknown>) => void
Parameters
- key: string
- val: MessageCodecs<unknown, unknown>
Returns (handler: (req: unknown) => Promise<unknown>) => void
- Defined in packages/workers/api/channel.ts:79

_createSender

_createSender(
key: string,
val: MessageCodecs<unknown, unknown>,
): (data: unknown) => Promise<unknown>
Parameters
- key: string
- val: MessageCodecs<unknown, unknown>
Returns (data: unknown) => Promise<unknown>
- Defined in packages/workers/api/channel.ts:105

destroy

destroy(): void
Returns void
- Defined in packages/workers/api/channel.ts:129

`Static`new

new<To, From>(
protocol: LousyProtocol<To, From>,
port: Port,
): Handlers<To> & Senders<From> & Destroy
Type Parameters
- To
- From
Parameters
- protocol: LousyProtocol<To, From>
- port: Port
Returns Handlers<To> & Senders<From> & Destroy
- Defined in packages/workers/api/channel.ts:34

`Static`rx

rx<To, From>(protocol: LousyProtocol<To, From>, port: Port): Rx<To, From>
Create receiving end of the channel (i.e. handling messages toWorker).
Type Parameters
- To
- From
Parameters
- protocol: LousyProtocol<To, From>
- port: Port
Returns Rx<To, From>
- Defined in packages/workers/api/channel.ts:24

`Static`tx

tx<To, From>(protocol: LousyProtocol<To, From>, port: Port): Tx<To, From>
Create transmitting end of the channel (i.e. handling messages fromWorker).
Type Parameters
- To
- From
Parameters
- protocol: LousyProtocol<To, From>
- port: Port
Returns Tx<To, From>
- Defined in packages/workers/api/channel.ts:29