Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InteractiveSocket

Hierarchy

  • EventEmitter
    • InteractiveSocket

Index

Constructors

constructor

Properties

Static WebSocket

WebSocket: any = typeof WebSocket === 'undefined' ? null : WebSocket

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

close

  • close(): void

connect

  • connect(): this
  • Open a new socket connection. By default, the socket will auto connect when creating a new instance.

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

execute

  • execute(method: string, params?: IRawValues, discard?: boolean): Promise<any>
  • Executes an RPC method on the server. Returns a promise which resolves after it completes, or after a timeout occurs.

    Parameters

    • method: string
    • Default value params: IRawValues = {}
    • Default value discard: boolean = false

    Returns Promise<any>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getOptions

getQueueSize

  • getQueueSize(): number

getState

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

reply

  • reply(reply: Reply): void

send

  • send(packet: Packet): Promise<any>
  • Send emits a Method over the websocket, wrapped in a Packet to provide queueing and cancellation. It returns a promise which resolves with the reply payload from the Server.

    Parameters

    Returns Promise<any>

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

setOptions

  • Set the given options. Defaults and previous option values will be used if not supplied.

    Parameters

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc