Class Channel<Payloads, Names>

Channel class. Allows to bind and unbind event callbacks including whisper events. Allows to trigger client events as well.

Type parameters

Payloads: EventListenerPayloads
Names: keyof Payloads

Hierarchy

EventListener
- Channel

Index

Constructors

constructor

Properties

Accessors

echo

Methods

Constructors

constructor

new Channel(type: ChannelType, name: string, echo: Echo | null, leaveFunc: function): Channel

- Defined in lib/echo/channel.ts:56
Parameters
- type: ChannelType
- name: string
- echo: Echo | null
- leaveFunc: function
  - - (): void
    - Returns void
Returns Channel

Properties

Private _echo

_echo: Echo | null = null

Protected callbacks

callbacks: object

An array of callbacks per event name

Type declaration

[eventName: string]: function[]

Private channel

channel: LaravelEchoChannel | null = null

debugEvents

debugEvents: boolean = false

Private leaveFunc

leaveFunc: function

Type declaration

- (): void
- Returns void

name

name: string

type

type: ChannelType

Accessors

echo

get echo(): null | Echo
set echo(echo: Echo | null): void

- Defined in lib/echo/channel.ts:72
Returns null | Echo
- Defined in lib/echo/channel.ts:66
Parameters
- echo: Echo | null
Returns void

Methods

Protected attachListeners

attachListeners(eventNames: string | string[]): void

- Defined in lib/echo/channel.ts:89
Attach event listeners to the real Laravel Echo channel instance.

Parameters
- eventNames: string | string[]
Returns void

dispatch

dispatch<T>(name: T, payload: Payloads[T]): void

Inherited from EventListener.dispatch
- Defined in lib/event-listener.ts:70
Dispatch an event.

Type parameters
- T: Names
Parameters
- name: T
- payload: Payloads[T]
Returns void

dispatchWhisper

dispatchWhisper(name: string, payload: any): void

- Defined in lib/echo/channel.ts:147
Dispatch a whisper event.

Parameters
- name: string
- payload: any
Returns void

leave

leave(): void

- Defined in lib/echo/channel.ts:81
Returns void

off

off<T>(name: T, callback: EventCallback<Payloads, T>): void

Inherited from EventListener.off
- Defined in lib/event-listener.ts:42
Detach an event listener from an event.

Type parameters
- T: Names
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

offWhisper

offWhisper(name: string, callback: EventCallback<any, any>): void

- Defined in lib/echo/channel.ts:129
Detach an event listener from a whisper event.

Parameters
- name: string
- callback: EventCallback<any, any>
Returns void

on

on(name: string, callback: EventCallback<any, string>): void

Overrides EventListener.on
- Defined in lib/echo/channel.ts:76
Parameters
- name: string
- callback: EventCallback<any, string>
Returns void

onWhisper

onWhisper(name: string, callback: EventCallback<any, any>): void

- Defined in lib/echo/channel.ts:120
Attach an event listener to a whisper event.

Parameters
- name: string
- callback: EventCallback<any, any>
Returns void

once

once<T>(name: T, callback: EventCallback<Payloads, T>): void

Inherited from EventListener.once
- Defined in lib/event-listener.ts:56
Attach an event listener to an event, but only once.

Type parameters
- T: Names
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

onceWhisper

onceWhisper(name: string, callback: EventCallback<any, any>): void

- Defined in lib/echo/channel.ts:138
Attach an event listener to a whisper event, but only once.

Parameters
- name: string
- callback: EventCallback<any, any>
Returns void

whisper

whisper(name: string, data: object): void

- Defined in lib/echo/channel.ts:156
Trigger a client event.

Parameters
- name: string
  
  Event name
- data: object
  
  Event data
Returns void

Generated using TypeDoc