PusherChannelMock | pusher-js-mock - v0.3.8

Class representing a fake Pusher channel.

Hierarchy

PusherChannelMock
- PusherPresenceChannelMock

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PusherChannelMock(name?: string): PusherChannelMock

- Defined in pusher-channel-mock.ts:10
Initialize PusherChannelMock with callbacks object.

Parameters
- Default value name: string = "public-channel"
Returns PusherChannelMock

Properties

callbacks

callbacks: ICallbacks

name

name: string

subscribed

subscribed: boolean = true

Methods

bind

bind(name: string, callback: function): this

- Defined in pusher-channel-mock.ts:23
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

- Defined in pusher-channel-mock.ts:57
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

trigger

trigger(name: string, data?: any): void

- Defined in pusher-channel-mock.ts:72
Trigger 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 void

unbind

unbind(name: string, callback: function): this

- Defined in pusher-channel-mock.ts:35
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

- Defined in pusher-channel-mock.ts:46
Unbind callbacks from all the events.

Returns this

Generated using TypeDoc