PusherMock | pusher-js-mock - v0.3.8

Class representing fake Pusher Client.

Hierarchy

PusherMock

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PusherMock(clientKey?: undefined | string, config?: IPusherMockOptions): PusherMock

- Defined in pusher-js-mock.ts:26
Initialize PusherMock

Parameters
- Optional clientKey: undefined | string
- Optional config: IPusherMockOptions
Returns PusherMock

Properties

channel

channel: channel = PusherMockInstance.channel

channels

channels: IChannels = PusherMockInstance.channels

clientKey

clientKey: string | undefined

config

config: IPusherMockOptions | undefined

connection

connection: any = PusherMockInstance.connection

id

id: string | undefined = undefined

info

info: Record<string, any> | undefined = undefined

Methods

allChannels

allChannels(): any[]

- Defined in pusher-js-mock.ts:126
Returns a list of all channels

Returns any[]

bind

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

- Defined in pusher-js-mock.ts:106
Bind a callback to an event on all channels

Parameters
- name: string
  
  name of the event to bind to.
- callback: function
  
  callback to be called on event.
  - - (): void
    - Returns void
Returns void

setAuthInfo

setAuthInfo(errored: boolean, auth: any): void

- Defined in pusher-js-mock.ts:37
Parameters
- errored: boolean
- auth: any
Returns void

subscribe

subscribe(name: string): any

- Defined in pusher-js-mock.ts:49
Mock subscribing to a channel.

Parameters
- name: string
  
  name of the channel.
Returns any

PusherChannelMock object that represents channel

unbind

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

- Defined in pusher-js-mock.ts:117
Unbind a callback from an event on all channels

Parameters
- name: string
  
  name of the event to unbind from.
- callback: function
  
  callback to be called on event.
  - - (): void
    - Returns void
Returns void

unsubscribe

unsubscribe(name: string): void

- Defined in pusher-js-mock.ts:71
Unsubscribe from a mocked channel.

Parameters
- name: string
  
  name of the channel.
Returns void

Generated using TypeDoc