Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SocketIoConnector

Hierarchy

Index

Constructors

constructor

Properties

channels

channels: any

All of the subscribed channel names.

options

options: Config

Connector options.

socket

socket: Socket

The Socket.io connection instance.

Methods

channel

connect

  • connect(): void
  • Create a fresh connection.

    Returns void

disconnect

  • disconnect(): void
  • Disconnect from the Echo server.

    Returns void

getSocketIO

  • getSocketIO(): SocketIOClientStatic
  • Get socket.io module from global scope or options.

    Returns SocketIOClientStatic

leave

  • leave(channel: string): void
  • Leave the given channel.

    Parameters

    • channel: string

    Returns void

listen

  • Listen for an event on a channel instance.

    Parameters

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

          • event: any

          Returns void

    Returns SocketIoChannel

presenceChannel

privateChannel

socketId

  • socketId(): string
  • Get the socket_id of the connection.

    Returns string