Class ChannelService

Interface for channel service

Implements

IChannelService

Index

Constructors

Methods

push pushParallel pushSequence subscribe waitForEvent

Constructors

constructor

new ChannelService(): ChannelService
Returns ChannelService

Methods

push

push<T = unknown>(
    channel: Channel,
    event: string,
    payload?: object,
    options?: PushOptions,
): Promise<T>
Push a message to a channel and wait for response
Type Parameters
- T = unknown
Parameters
- channel: Channel
- event: string
- payload: object = {}
- options: PushOptions = {}
Returns Promise<T>
Implementation of IChannelService.push
- Defined in packages/core/src/services/ChannelService.ts:20

pushParallel

pushParallel(
channel: Channel,
operations: BatchPushOperation[],
): Promise<PushResult<unknown>[]>
Push multiple operations in parallel
Parameters
- channel: Channel
- operations: BatchPushOperation[]
Returns Promise<PushResult<unknown>[]>
Implementation of IChannelService.pushParallel
- Defined in packages/core/src/services/ChannelService.ts:89

pushSequence

pushSequence(
channel: Channel,
operations: BatchPushOperation[],
): Promise<PushResult<unknown>[]>
Push multiple operations sequentially
Parameters
- channel: Channel
- operations: BatchPushOperation[]
Returns Promise<PushResult<unknown>[]>
Implementation of IChannelService.pushSequence
- Defined in packages/core/src/services/ChannelService.ts:58

subscribe(
    channel: Channel,
    event: string,
    handler: (payload: unknown) => void,
): () => void
Subscribe to channel events
Parameters
- channel: Channel
- event: string
- handler: (payload: unknown) => void
Returns () => void
Implementation of IChannelService.subscribe
- Defined in packages/core/src/services/ChannelService.ts:113

waitForEvent

waitForEvent<T = unknown>(
    channel: Channel,
    event: string,
    timeoutMs?: number,
): Promise<T>
Wait for a specific event on a channel
Type Parameters
- T = unknown
Parameters
- channel: Channel
- event: string
- timeoutMs: number = ...
Returns Promise<T>
Implementation of IChannelService.waitForEvent
- Defined in packages/core/src/services/ChannelService.ts:121