pusher-js-mock - v0.3.8
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a collection of members of a presence channel.

Hierarchy

  • Members

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Members(members?: any): Members

Properties

count

count: number

me

me: any

members

members: any

myID

myID: any

Methods

addMember

  • addMember(memberData: any): any

  • Adds a new member to the collection. For internal use only.

    Parameters

    • memberData: any

    Returns any

each

  • each(callback: Function): void

  • Calls back for each member in unspecified order.

    Parameters

    • callback: Function

    Returns void

get

  • get(id: string): any

  • Returns member's info for given id.

    Resulting object containts two fields - id and info.

    Parameters

    • id: string

    Returns any

    member's info or null

removeMember

  • removeMember(memberData: any): any

  • Adds a member from the collection. For internal use only.

    Parameters

    • memberData: any

    Returns any

reset

  • reset(members?: any): void

  • Resets the collection to the initial state. For internal use only.

    Parameters

    • Optional members: any

    Returns void

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