Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DelayCall

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DelayCall(globalDelay?: number): DelayCall

  • Parameters

    • Default value globalDelay: number = 25

      Ignore requests with the same unique name if repeated during this time. You can also set each as a delay parameter for the request method. The default value of the delay is 25

    Returns DelayCall

Properties

Protected Readonly __delay

__delay: number = 25

Protected Readonly __queue

__queue: DelayCallQueue = new Map

Static prefixed

prefixed: string | boolean

Methods

Protected __cancel

Protected __cancelAll

Protected __clearTimeout

Protected __done

Protected __getQueueItem

Protected __request

Protected __setTimeout

Protected __waitCall

addListener

  • addListener<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: Context): this

  • Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: Context

    Returns this

cancel

  • Cancel the requested task with the id parameter.

    Parameters

    Returns boolean

    If there was a scheduled task, return true, otherwise false.

cancelAll

  • cancelAll(): void

  • Cancel all requested tasks.

    Returns void

destroy

  • destroy(): void

  • Call before destroying an instance.

    Returns void

done

  • Wait until the requested task of the id parameter is actually called. If canceled by cancel method, emit error.

    Parameters

    Returns Promise<void>

    The Promise instance.

emit

  • emit<T>(event: T, ...args: EventEmitter.EventArgs<string | symbol, T>): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Rest ...args: EventEmitter.EventArgs<string | symbol, T>

    Returns boolean

eventNames

  • eventNames(): Array<EventEmitter.EventNames<string | symbol>>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventEmitter.EventNames<string | symbol>>

listenerCount

  • listenerCount(event: EventEmitter.EventNames<string | symbol>): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: EventEmitter.EventNames<string | symbol>

    Returns number

listeners

  • listeners<T>(event: T): Array<EventEmitter.EventListener<string | symbol, T>>

  • Return the listeners registered for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T

    Returns Array<EventEmitter.EventListener<string | symbol, T>>

off

  • off<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: Context, once?: undefined | false | true): this

  • Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: Context
    • Optional once: undefined | false | true

    Returns this

on

  • on<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: Context): this

  • Add a listener for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: Context

    Returns this

once

  • once<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: Context): this

  • Add a one-time listener for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: Context

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventEmitter.EventNames<string | symbol>): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: EventEmitter.EventNames<string | symbol>

    Returns this

removeListener

  • removeListener<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: Context, once?: undefined | false | true): this

  • Remove the listeners of a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: Context
    • Optional once: undefined | false | true

    Returns this

request

  • Request to execute the callback function. The function is not called immediately and waits as much as the delay parameter. The default value of the delay is this.__delay.

    Parameters

    • id: DelayCallID

      It's a unique name for the task. If this value is called in duplicate, the existing task is ignored.

    • callback: DelayCallback

      The callback function to be called.

    • Default value delay: number = this.__delay

      Ignore requests with the same unique name if repeated during this time.

    Returns this

    This instance.

Generated using TypeDoc