Class ApiGatewayWsBroadcaster

A serverless Broadcaster for API Gateway WebSocket APIs.

With no held sockets, a broadcast reads the channel's members from the shared store and posts to each connection via the API Gateway Management API. The management endpoint is per-invocation (it comes from the event), so the adapter calls useEndpoint before dispatching. Local listeners are also notified, for handlers that react within the same invocation.

Implements

Broadcaster

Index

Constructors

Properties

Methods

broadcast members on to useEndpoint create

Constructors

constructor

new ApiGatewayWsBroadcaster(
options?: ApiGatewayWsBroadcasterOptions,
): ApiGatewayWsBroadcaster
Parameters
- options: ApiGatewayWsBroadcasterOptions = {}
  The broadcaster options.
Returns ApiGatewayWsBroadcaster

Properties

`Readonly`name

name: string

A human-readable name (e.g. 'memory', 'redis').

`Readonly`store

store: ConnectionStore

Methods

broadcast

broadcast<T = unknown>(
    channel: string,
    event: string,
    payload?: T,
): Promise<void>
Type Parameters
- T = unknown
Parameters
- channel: string
- event: string
- Optionalpayload: T
Returns Promise<void>

Inherit Doc

Implementation of Broadcaster.broadcast

members

members(channel: string): Promise<PresenceMember<unknown>[]>
Parameters
- channel: string
Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

Implementation of Broadcaster.members

on

on<T = unknown>(channel: string, listener: RealtimeListener<T>): () => void
Type Parameters
- T = unknown
Parameters
- channel: string
- listener: RealtimeListener<T>
Returns () => void

Inherit Doc

Implementation of Broadcaster.on

to

to(
channel: string,
): { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }
Parameters
- channel: string
Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

Inherit Doc

Implementation of Broadcaster.to

useEndpoint

useEndpoint(endpoint: string): void
Set the management endpoint for the current invocation (rebuilds the client when it changes).
Parameters
- endpoint: string
  The https://<domain>/<stage> endpoint.
Returns void

`Static`create

create(options?: ApiGatewayWsBroadcasterOptions): ApiGatewayWsBroadcaster
Create a broadcaster.
Parameters
- options: ApiGatewayWsBroadcasterOptions = {}
  The broadcaster options.
Returns ApiGatewayWsBroadcaster
A new broadcaster.