Interface ReceiveMessageOptions

Options that can be passed to SyncMessagePort.receiveMessage.

interface ReceiveMessageOptions {
    closedValue?: unknown;
    timeout?: number;
    timeoutValue?: unknown;
}

closedValue?: unknown

If the underlying channel is closed before calling SyncMessagePort.receiveMessage or while a call is pending, return this value.

timeout?: number

The time (in milliseconds) to wait for a message before returning timeoutValue (if set) or throwing a [TimeoutException] otherwise.

timeoutValue?: unknown

If a message isn't received within timeout milliseconds, this value is returned. Ignored if timeout is not set.

Properties