Class Limiter

A limiter is a queue system that allows you to control the rate of job processing. It can be used to limit the number of concurrent jobs, the delay between each job, the maximum number of jobs in the queue, and the strategy to use when the queue length reaches highWater.

Hierarchy (View Summary)

Constructors

constructor

Accessors

options pending size

Methods

addListener clear execute off on once pipe prependListener prependOnceListener removeAllListeners removeListener schedule start stop waitUntilEmpty

Constructors

constructor

Accessors

options

pending

  • get pending(): number

  • Returns the number of pending jobs

    Returns number

size

  • get size(): number

  • Returns the number of jobs in the queue

    Returns number

Methods

addListener

  • addListener(event: string, listener: DoneListener): this

  • Register an event listener over the done event, which is emitted when a task has ended, either due to completion or failure.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      Done event listener

    Returns this

    Event

  • addListener(event: "refill", listener: () => void): this

  • Register an event listener over the refill event, which is emitted when queue bucket is refilled

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      Refill event listener

    Returns this

    Event

  • addListener(event: "seed", listener: () => void): this

  • Register an event listener over the seed event, which is emitted when queue is empty and a new task is added

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to add

    Returns this

    Event

clear

execute

  • execute<T, U>(task: TaskHandler<T, U>): Promise<T>

  • Executes a task and returns a promise that resolves when the task is done

    Type Parameters

    • T
    • U

    Parameters

    Returns Promise<T>

    A promise that resolves when the task is done

  • execute<T, U>(
        task: TaskAsPromise<T>,
        taskArgs?: TaskArguments,
        options?: TaskOptions<U>,
    ): Promise<T>

  • Executes a task and returns a promise that resolves when the task is done

    Type Parameters

    • T
    • U

    Parameters

    Returns Promise<T>

    A promise that resolves when the task is done

off

  • off(event: string, listener: DoneListener): this

  • Removes the specified listener from the listener array for the done event.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      The listener function to remove

    Returns this

    Event

  • off(event: "refill", listener: () => void): this

  • Removes the specified listener from the listener array for the refill event.

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      The listener function to remove

    Returns this

    Event

  • off(event: "seed", listener: () => void): this

  • Removes the specified listener from the listener array for the seed event.

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to remove

    Returns this

    Event

on

  • on(event: string, listener: DoneListener): this

  • Register an event listener over the done event, which is emitted when a task has ended, either due to completion or failure.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      Done event listener

    Returns this

    Event

  • on(event: "refill", listener: () => void): this

  • Register an event listener over the refill event, which is emitted when queue bucket is refilled

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      Refill event listener

    Returns this

    Event

  • on(event: "seed", listener: () => void): this

  • Register an event listener over the seed event, which is emitted when queue is empty and a new task is added

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to add

    Returns this

    Event

once

  • once(event: string, listener: DoneListener): this

  • Registers a one-time event listener over the done event, which is emitted when a task has ended, either due to completion or failure.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      Done event listener

    Returns this

    Event

  • once(event: "refill", listener: () => void): this

  • Registers a one-time event listener over the refill event, which is emitted when queue bucket is refilled

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      Refill event listener

    Returns this

    Event

  • once(event: "seed", listener: () => void): this

  • Registers a one-time event listener over the seed event, which is emitted when queue is empty and a new task is added

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to add

    Returns this

    Event

pipe

  • pipe(limiter: Limiter): void

  • Pipes the limiter to another limiter

    Parameters

    Returns void

prependListener

  • prependListener(event: string, listener: DoneListener): this

  • Registers a event listener over the done event, at the beginning of the listeners array, which is emitted when a task has ended, either due to completion or failure.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      Done event listener

    Returns this

    Event

  • prependListener(event: "refill", listener: () => void): this

  • Registers a event listener over the refill event, at the beginning of the listeners array, which is emitted when queue bucket is refilled

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      Refill event listener

    Returns this

    Event

  • prependListener(event: "seed", listener: () => void): this

  • Registers a event listener over the seed event, at the beginning of the listeners array, which is emitted when queue is empty and a new task is added

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to add

    Returns this

    Event

prependOnceListener

  • prependOnceListener(event: string, listener: DoneListener): this

  • Registers a one-time event listener over the done event, at the beginning of the listeners array, which is emitted when a task has ended, either due to completion or failure.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      Done event listener

    Returns this

    Event

  • prependOnceListener(event: "refill", listener: () => void): this

  • Registers a one-time event listener over the refill event, at the beginning of the listeners array, which is emitted when queue bucket is refilled

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      Refill event listener

    Returns this

    Event

  • prependOnceListener(event: "seed", listener: () => void): this

  • Registers a one-time event listener over the seed event, at the beginning of the listeners array, which is emitted when queue is empty and a new task is added

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to add

    Returns this

    Event

removeAllListeners

  • removeAllListeners(event?: "done"): this

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

    Parameters

    • Optionalevent: "done"

      done event

    Returns this

    Event

  • removeAllListeners(event?: "refill"): this

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

    Parameters

    • Optionalevent: "refill"

      refill event

    Returns this

    Event

  • removeAllListeners(event?: "seed"): this

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

    Parameters

    • Optionalevent: "seed"

      seed event

    Returns this

    Event

removeListener

  • removeListener(event: string, listener: DoneListener): this

  • Removes the specified listener from the listener array for the done event.

    Parameters

    • event: string

      done event

    • listener: DoneListener

      The listener function to remove

    Returns this

    Event

  • removeListener(event: "refill", listener: () => void): this

  • Removes the specified listener from the listener array for the refill event.

    Parameters

    • event: "refill"

      refill event

    • listener: () => void

      The listener function to remove

    Returns this

    Event

  • removeListener(event: "seed", listener: () => void): this

  • Removes the specified listener from the listener array for the seed event.

    Parameters

    • event: "seed"

      seed event

    • listener: () => void

      The listener function to remove

    Returns this

    Event

schedule

  • schedule<T, U>(task: TaskHandler<T, U>): undefined | string

  • Schedules a task to be executed by the limiter

    Type Parameters

    • T
    • U

    Parameters

    Returns undefined | string

    The task handler

  • schedule<T, U>(
        task: TaskAsPromise<T>,
        taskArgs?: TaskArguments,
        options?: TaskOptions<U>,
    ): undefined | string

  • Schedules a task to be executed by the limiter

    Type Parameters

    • T
    • U

    Parameters

    Returns undefined | string

    The task handler

start

  • start(): void

  • Starts the limiter

    Returns void

stop

  • stop(): void

  • Stops the limiter

    Returns void

waitUntilEmpty

  • waitUntilEmpty(): Promise<void>

  • Waits until the queue is empty

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods