Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client<IN, IEventsList>

Type parameters

Hierarchy

Indexable

[key: string]: any

Index

Constructors

Static constructor

  • new Client(id?: string): any
  • Parameters

    • Optional id: string

    Returns any

Properties

Static List

List: TClass<IN>

Static Optional client

client: any

Static emitter

emitter: EventEmitter

Static id

id: string

Static isDestroyed

isDestroyed: boolean

Static isStarted

isStarted: boolean

Methods

Static add

  • add(node: IN): this
  • Parameters

    • node: IN

    Returns this

Static destroy

  • destroy(): void
  • Returns void

Static emit

  • emit<IE>(eventName: IE, data: IEventsList[IE]): this
  • Type parameters

    • IE: keyof IEventsList

    Parameters

    • eventName: IE
    • data: IEventsList[IE]

    Returns this

Static generateId

  • generateId(): string
  • Returns string

Static off

  • off<IE>(eventName: IE, listener: function): this
  • Type parameters

    • IE: keyof IEventsList

    Parameters

    • eventName: IE
    • listener: function
        • (data: IEventsList[IE]): void
        • Parameters

          • data: IEventsList[IE]

          Returns void

    Returns this

Static on

  • on<IE>(eventName: IE, listener: function): this
  • Type parameters

    • IE: keyof IEventsList

    Parameters

    • eventName: IE
    • listener: function
        • (data: IEventsList[IE]): void
        • Parameters

          • data: IEventsList[IE]

          Returns void

    Returns this

Static once

  • once<IE>(eventName: IE, listener: function): this
  • Type parameters

    • IE: keyof IEventsList

    Parameters

    • eventName: IE
    • listener: function
        • (data: IEventsList[IE]): void
        • Parameters

          • data: IEventsList[IE]

          Returns void

    Returns this

Static remove

  • remove(node: IN): this
  • Parameters

    • node: IN

    Returns this

Static start

  • start(): Promise<void>

Static starting

  • starting(): Promise<void>

Static stop

  • stop(): Promise<void>

Static stopping

  • stopping(): Promise<void>

Static tracking

  • tracking(tracker: any): void

Static untracking

  • untracking(tracker: any): void

Static wrap

  • wrap(node: IN): this
  • Parameters

    • node: IN

    Returns this

Generated using TypeDoc