Class DypaiRealtimeClient

Index

Constructors

Methods

channel disconnect getChannels removeAllChannels removeChannel setAuth

Constructors

constructor

new DypaiRealtimeClient(
baseUrl: string,
tokenProvider: () => string | null,
): DypaiRealtimeClient
Parameters
- baseUrl: string
- tokenProvider: () => string | null
Returns DypaiRealtimeClient
- Defined in src/modules/realtime/RealtimeClient.ts:404

Methods

channel

channel(topic: string, config?: { config?: ChannelConfig }): RealtimeChannel
Parameters
- topic: string
- Optionalconfig: { config?: ChannelConfig }
Returns RealtimeChannel
- Defined in src/modules/realtime/RealtimeClient.ts:409

disconnect

disconnect(): void
Returns void
- Defined in src/modules/realtime/RealtimeClient.ts:449

getChannels

getChannels(): RealtimeChannel[]
Returns RealtimeChannel[]
- Defined in src/modules/realtime/RealtimeClient.ts:419

removeAllChannels

removeAllChannels(): Promise<void>
Returns Promise<void>
- Defined in src/modules/realtime/RealtimeClient.ts:429

removeChannel

removeChannel(channel: RealtimeChannel): Promise<void>
Parameters
- channel: RealtimeChannel
Returns Promise<void>
- Defined in src/modules/realtime/RealtimeClient.ts:423

setAuth

setAuth(token?: string | null): Promise<void>
Update auth token. Reconnects with new token if currently connected.
Parameters
- Optionaltoken: string | null
Returns Promise<void>
- Defined in src/modules/realtime/RealtimeClient.ts:438