Class Channel

Index

Constructors

Accessors

Methods

join leave on push

Constructors

constructor

new Channel(
    socket: Socket,
    topic: string,
    params: Record<string, unknown>,
): Channel
Parameters
- socket: Socket
- topic: string
- params: Record<string, unknown>
Returns Channel
- Defined in packages/sdk/src/phx_channel/channel.ts:47

Accessors

isJoined

get isJoined(): boolean
Returns boolean
- Defined in packages/sdk/src/phx_channel/channel.ts:61

state

get state(): ChannelState
Returns ChannelState
- Defined in packages/sdk/src/phx_channel/channel.ts:57

Methods

join

join(
payload?: Record<string, unknown>,
options?: JoinOptions,
): Promise<Record<string, unknown>>
Parameters
- Optionalpayload: Record<string, unknown>
- Optionaloptions: JoinOptions
Returns Promise<Record<string, unknown>>
- Defined in packages/sdk/src/phx_channel/channel.ts:67

leave

leave(timeoutMs?: number): Promise<void>
Parameters
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in packages/sdk/src/phx_channel/channel.ts:112

on

on(event: string, callback: (payload: unknown) => void): () => void
Parameters
- event: string
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/phx_channel/channel.ts:219

push

push(event: string, payload?: unknown, timeoutMs?: number): Promise<unknown>
Parameters
- event: string
- payload: unknown = {}
- OptionaltimeoutMs: number
Returns Promise<unknown>
- Defined in packages/sdk/src/phx_channel/channel.ts:156