Class ConnectionManager

Laravel Echo connection manager

Hierarchy

EventListener<Payloads, ConnectionManagerEvents>
- ConnectionManager

Implements

Iterable<Channel>

Index

Properties

Methods

Object literals

Properties

Protected callbacks

callbacks: object

An array of callbacks per event name

Type declaration

[eventName: string]: function[]

Protected csrfToken

csrfToken: string | null = null

debugEvents

debugEvents: boolean = false

Protected echo

echo: Echo | null = null

Protected host

host: string | null = null

Methods

__@iterator

__@iterator(): Iterator<Channel>

- Defined in lib/echo/index.ts:48
Returns Iterator<Channel>

channel

channel(type: ChannelType, name: string, rejoinOnReconnect?: undefined | true | false): Channel

- Defined in lib/echo/index.ts:138
Get a Channel instance.

Parameters
- type: ChannelType
  
  Channel type.
- name: string
  
  Channel name.
- Optional rejoinOnReconnect: undefined | true | false
  
  Whether this channel should automatically rejoin on echo reconnect.
Returns Channel

connect

connect(host: string | null, csrfToken: string | null, forceReconnect?: boolean): void

- Defined in lib/echo/index.ts:89
Connect or reconnect to a host.

Parameters
- host: string | null
- csrfToken: string | null
- Default value forceReconnect: boolean = false
Returns void

disconnect

disconnect(): void

- Defined in lib/echo/index.ts:127
Disconnect from a host.

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: ConnectionManagerEvents
Parameters
- name: T
- payload: Payloads[T]
Returns void

leave

leave(name: string): void

- Defined in lib/echo/index.ts:153
Leave a channel

Parameters
- name: string
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: ConnectionManagerEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

on

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

Inherited from EventListener.on
- Defined in lib/event-listener.ts:29
Attach an event listener to an event.

Type parameters
- T: ConnectionManagerEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
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: ConnectionManagerEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

reconnect

reconnect(): void

- Defined in lib/echo/index.ts:120
Reconnect to the host.

Returns void

Private replaceEcho

replaceEcho(echo: Echo | null, host: string | null, csrfToken: string | null): void

- Defined in lib/echo/index.ts:66
Replace the internal Echo instance

Parameters
- echo: Echo | null
- host: string | null
- csrfToken: string | null
Returns void

Object literals

Protected channels

channels: object

presence

presence: object

Type declaration

private

private: object

Type declaration

public

public: object

Type declaration

Protected rejoinOnReconnect

rejoinOnReconnect: object

presence

presence: object

Type declaration

private

private: object

Type declaration

public

public: object

Type declaration

Generated using TypeDoc