Class RunQueue

constructor

• new RunQueue(id, options?): RunQueue

• Parameters

  • id: string

    A technical but human-readable ID for this queue
  • options: RunQueueOptions = {}

    Options for customizing the behavior of the queue

  Returns RunQueue

Readonly continuousWorkMaxEntries

Readonly continuousWorkTimeLimitMSec

Readonly id

Readonly maxParallel

Readonly cancelAll

• cancelAll(): void

• Cancels all outstanding cancelable entries

  Returns void

Readonly getQueueLength

• getQueueLength(): number

• Gets the total queue length, which may include canceled entries that haven't been purged yet and delayed entries that aren't yet ready for execution

  Returns number

Readonly schedule

• schedule<T>(priority, id, run, options?): RunQueueEntry<T>

• Schedules a new entry to be run.

  Type Parameters

  • T

  Parameters

  • priority: number

    Lower number is higher priority
  • id: string

    A technical but human-readable ID of the entry
  • run: (() => T | Promise<T>)

    The function to run

    • • (): T | Promise<T>

      • Returns T | Promise<T>

  • options: RunQueueScheduleOptions = {}

    Options to effect the processing of this entry

  Returns RunQueueEntry<T>

  An entry reference, which can be used to cancel the entry, check its status, or to get the promised value.