Class LaravelEchoBroadcastClient

Implements

BroadcastClient

Index

Constructors

Methods

connect disconnect isConnected subscribe subscribeToUser

Constructors

constructor

new LaravelEchoBroadcastClient(
    echo: Echo<any>,
    channelPrefix?: string,
    channelTypes?: ChannelTypeConfig,
): LaravelEchoBroadcastClient
Parameters
- echo: Echo<any>
- channelPrefix: string = "chat"
- OptionalchannelTypes: ChannelTypeConfig
Returns LaravelEchoBroadcastClient
- Defined in client/LaravelEchoBroadcastClient.ts:23

Methods

connect

connect(): void | Promise<void>
Returns void | Promise<void>
Implementation of BroadcastClient.connect
- Defined in client/LaravelEchoBroadcastClient.ts:41

disconnect

disconnect(): void
Returns void
Implementation of BroadcastClient.disconnect
- Defined in client/LaravelEchoBroadcastClient.ts:45

isConnected

isConnected(): boolean
Returns boolean
Implementation of BroadcastClient.isConnected
- Defined in client/LaravelEchoBroadcastClient.ts:107

subscribe(threadId: string, handlers: EventHandlers): Unsubscribe
Parameters
- threadId: string
- handlers: EventHandlers
Returns Unsubscribe
Implementation of BroadcastClient.subscribe
- Defined in client/LaravelEchoBroadcastClient.ts:53

subscribeToUser

subscribeToUser(
    threadId: string,
    userId: string,
    handlers: EventHandlers,
): Unsubscribe
Parameters
- threadId: string
- userId: string
- handlers: EventHandlers
Returns Unsubscribe
Implementation of BroadcastClient.subscribeToUser
- Defined in client/LaravelEchoBroadcastClient.ts:81