Options
All
  • Public
  • Public/Protected
  • All
Menu

Basic augmentation of the PusherChannel class.

Hierarchy

Index

Constructors

constructor

Properties

Optional IS_PROXY

IS_PROXY: undefined | false | true

callbacks

callbacks: ICallbacks

members

members: Members

name

name: string

subscribed

subscribed: boolean = true

trigger

trigger: emit = this.emit

Alias to match actual API for client events

Methods

bind

  • bind(name: string, callback: function): this
  • Bind callback to an event name.

    Parameters

    • name: string

      name of the event.

    • callback: function

      callback to be called on event.

        • (): void
        • Returns void

    Returns this

emit

  • emit(name: string, data?: any): this
  • Emit event with data.

    Parameters

    • name: string

      name of the event.

    • Optional data: any

      data you want to pass in to callback function that gets called.

    Returns this

unbind

  • unbind(name: string, callback: function): this
  • Unbind callback from an event name.

    Parameters

    • name: string

      name of the event.

    • callback: function

      callback to be called on event.

        • (): void
        • Returns void

    Returns this

unbind_all

  • unbind_all(): this

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc