Interface Connector

Hierarchy

Connector

Callable

__call(options: Config): Connector

- Defined in laravel-echo.d.ts:166
Create a new class instance.

Parameters
- options: Config
Returns Connector

Index

Properties

Methods

Properties

channels

channels: any

All of the subscribed channel names.

options

options: Config

Connector options.

Methods

channel

channel(channel: string): Channel

- Defined in laravel-echo.d.ts:197
Get a channel instance by name.

Parameters
- channel: string
Returns Channel

connect

connect(): void

- Defined in laravel-echo.d.ts:179
Create a fresh connection.

Returns void

disconnect

disconnect(): void

- Defined in laravel-echo.d.ts:232
Disconnect from the Echo server.

Returns void

leave

leave(channel: string): void

- Defined in laravel-echo.d.ts:220
Leave the given channel.

Parameters
- channel: string
Returns void

listen

listen(name: string, event: string, callback: function): Channel

- Defined in laravel-echo.d.ts:189
Listen for an event on a channel instance.

Parameters
- name: string
- event: string
- callback: function
  - - (event: any): void
    - Parameters
      - event: any
      Returns void
Returns Channel

presenceChannel

presenceChannel(channel: string): PresenceChannel

- Defined in laravel-echo.d.ts:213
Get a presence channel instance by name.

Parameters
- channel: string
Returns PresenceChannel

privateChannel

privateChannel(channel: string): PrivateChannel

- Defined in laravel-echo.d.ts:205
Get a private channel instance by name.

Parameters
- channel: string
Returns PrivateChannel

socketId

socketId(): string

- Defined in laravel-echo.d.ts:227
Get the socket_id of the connection.

Returns string