Interface WorkerClient<T>

One of the application's workers, as useWorker returns it.

interface WorkerClient<T extends WorkerTypes = WorkerTypes> {
    post(
        ...args: T["payload"] extends void
            ? [payload?: void, options?: MessageBusEmitOptions]
            : [payload: T["payload"], options?: MessageBusEmitOptions],
    ): Promise<T["reply"]>;
    subscribe(handler: (message: T["message"]) => void): () => void;
}

Type Parameters

T extends WorkerTypes = WorkerTypes

Index

Methods

post subscribe

Methods

post

post(
    ...args: T["payload"] extends void
        ? [payload?: void, options?: MessageBusEmitOptions]
        : [payload: T["payload"], options?: MessageBusEmitOptions],
): Promise<T["reply"]>
Posts to the worker and resolves with its reply. Rejects with a MessageBusError whose code is NO_RESPONDER when the worker isn't running, TIMEOUT, ABORTED, or REFUSED or HANDLER_THREW when the worker refuses.
Parameters
- ...args: T["payload"] extends void
  ? [payload?: void, options?: MessageBusEmitOptions]
  : [payload: T["payload"], options?: MessageBusEmitOptions]
Returns Promise<T["reply"]>
- Defined in packages/react/src/hooks/dashboard/useWorker.ts:29

subscribe(handler: (message: T["message"]) => void): () => void
Runs a handler for each message the worker sends, and returns a function that stops it.
Parameters
- handler: (message: T["message"]) => void
Returns () => void
- Defined in packages/react/src/hooks/dashboard/useWorker.ts:35

Interface WorkerClient<T>

Type Parameters

Index

Methods

Methods

post

Parameters

Returns Promise<T["reply"]>

Parameters

Returns () => void

Settings

On This Page