workloads / main / BroadcastPublisher

Class: BroadcastPublisher<C>

Publisher. Handles connection management, authentication, and provides an interface for publishing events.

Type Parameters

Type Parameter
C extends Record<string, ChannelData<any>>

Constructors

new BroadcastPublisher()

new BroadcastPublisher<C>(): BroadcastPublisher<C>

Returns

BroadcastPublisher<C>

Methods

connect()

connect(): Promise<void>

Establishes a connection to the AWS AppSync Events WebSocket API.

Returns

Promise<void>

A Promise that resolves when the connection is successfully established.

---

disconnect()

disconnect(): void

Disconnects from the AWS AppSync Events WebSocket API.

Returns

void

---

publishTo()

publishTo<T>(
   channelName, 
   params, 
data): Promise<boolean>

Type Parameters

Type Parameter
T extends string

Parameters

Parameter	Type
channelName	ValidateUniqueParams<T>
params	RouteParams<T>
data	C[T] extends ChannelData<P> ? P[] : never

Returns

Promise<boolean>