Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Server

Hierarchy

  • EventEmitter
    • Server

Index

Constructors

constructor

Properties

Private _server

_server: WS.Server

clients

clients: Map<string, WST> = new Map()

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

  • emit(event: "listening", host: string, port: number): boolean
  • emit(event: "close"): boolean
  • emit(event: "error", error: Error): boolean
  • emit(event: "connection", client: WST): boolean
  • Parameters

    • event: "listening"
    • host: string
    • port: number

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "connection"
    • client: WST

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

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

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "listening", listener: (host: string, port: number) => void): this
  • on(event: "close", listener: () => void): this
  • on(event: "error", listener: (error: Error) => void): this
  • on(event: "connection", listener: (client: WST) => void): this
  • Parameters

    • event: "listening"
    • listener: (host: string, port: number) => void
        • (host: string, port: number): void
        • Parameters

          • host: string
          • port: number

          Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: () => void
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "connection"
    • listener: (client: WST) => void
        • (client: WST): void
        • Parameters

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc