Class TaskQueue<PriorityType>

constructor

• new TaskQueue<PriorityType = undefined>(
      comparator: Maybe<Comparator<PriorityType>>,
      defaultPriority: PriorityType,
  ): TaskQueue<PriorityType>

  Use createTaskQueue to construct a new TaskQueue.

  Type Parameters

  • PriorityType = undefined

  Parameters

  • comparator: Maybe<Comparator<PriorityType>>

    A comparator for comparing two task priorities.
  • defaultPriority: PriorityType

    The default priority if not provided. If comparator is nullish priority values will have no effect.

  Returns TaskQueue<PriorityType>

Readonlycomparator

ReadonlydefaultPriority

running

• get running(): number

  How many tasks are currently running.

  Returns number

simultaneous

• get simultaneous(): number

  Returns number

• set simultaneous(value: number): void

  How many simultaneous tasks may be run at a time. Reducing this will not abort currently running tasks.

  Parameters

  • value: number

  Returns void

abort

• abort(reason?: Error): void

  Aborts all enqueued operations.

  Parameters

  • reason: Error = ...

  Returns void

enqueue

• enqueue<T>(task: Task<T>, priority?: PriorityType): Promise<T>

  Enqueues the given task, returning a Promise that settles when the task is complete.

  Type Parameters

  • T

  Parameters

  • task: Task<T>

    A function that is optionally asynchronous.
  • priority: PriorityType = ...

    The priority of the task. If not provided, defaultPriority() will be used.

  Returns Promise<T>