Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EchoStatic

Hierarchy

  • EchoStatic

Index

Constructors

constructor

Properties

connector

The broadcasting connector.

options

options: Config

The echo options.

Methods

channel

  • channel(channel: string): Channel

disconnect

  • disconnect(): void

join

leave

  • leave(channel: string): void

listen

  • listen(channel: string, event: string, callback: function): Channel
  • Listen for an event on a channel instance.

    Parameters

    • channel: string
    • event: string
    • callback: function
        • (event: any): void
        • Parameters

          • event: any

          Returns void

    Returns Channel

private

registerAxiosRequestInterceptor

  • registerAxiosRequestInterceptor(): void
  • Register an Axios HTTP interceptor to add the X-Socket-ID header.

    Returns void

registerVueRequestInterceptor

  • registerVueRequestInterceptor(): void
  • Register a Vue HTTP interceptor to add the X-Socket-ID header.

    Returns void

registerjQueryAjaxSetup

  • registerjQueryAjaxSetup(): void
  • Register jQuery AjaxSetup to add the X-Socket-ID header.

    Returns void

socketId

  • socketId(): string