MCPcopy Create free account

hub / github.com/sindresorhus/p-queue / functions

Functions74 in github.com/sindresorhus/p-queue

⨍ Functions 74◇ Types & classes 4
↓ 15 callersMethodadd
(function_: Task<TaskResultType>, options: Partial<EnqueueOptionsType> = {})
source/index.ts:441
↓ 8 callersMethodonIdle
The difference with `.onEmpty` is that `.onIdle` guarantees that all work from the queue has finished. `.onEmpty` merely signals that the queue is emp
source/index.ts:684
↓ 7 callersMethodstart
Start (or resume) executing enqueued tasks within concurrency limit. No need to call this if queue is not paused (via `options.autoStart = false` or b
source/index.ts:594
↓ 6 callersMethod#onEvent
(events: EventName | EventName[], filter?: () => boolean)
source/index.ts:769
↓ 6 callersMethodfilter
(options: Readonly<Partial<PriorityQueueOptions>>)
source/priority-queue.ts:102
↓ 4 callersMethod#scheduleRateLimitUpdate
()
source/index.ts:841
↓ 4 callersMethod#tryToStartAnother
()
source/index.ts:280
↓ 4 callersMethodclear
Clear the queue.
source/index.ts:615
↓ 4 callersMethodenqueue
(run: RunFunction, options?: Partial<PriorityQueueOptions>)
source/priority-queue.ts:17
↓ 4 callersMethodpause
Put queue execution on hold.
source/index.ts:608
↓ 3 callersMethod#cleanupStrictTicks
(now: number)
source/index.ts:140
↓ 3 callersMethod#clearIntervalTimer
()
source/index.ts:266
↓ 3 callersMethod#getActiveTicksCount
()
source/index.ts:182
↓ 3 callersMethod#processQueue
Executes all queued functions until it reaches the limit.
source/index.ts:374
↓ 3 callersMethoddequeue
()
source/priority-queue.ts:82
↓ 3 callersMethodonEmpty
Can be called multiple times. Useful if you for example add additional items at a later time. @returns A promise that settles when the queue becomes
source/index.ts:651
↓ 3 callersMethodonRateLimit
@returns A promise that settles when the queue becomes rate-limited due to intervalCap.
source/index.ts:709
↓ 3 callersMethodsetPriority
Updates the priority of a promise function by its id, affecting its execution order. Requires a defined concurrency limit to take effect. For exampl
source/index.ts:429
↓ 2 callersMethod#clearTimeoutTimer
()
source/index.ts:273
↓ 2 callersMethod#compact
()
source/priority-queue.ts:119
↓ 2 callersMethod#initializeIntervalIfNeeded
()
source/index.ts:331
↓ 2 callersMethod#onInterval
()
source/index.ts:351
↓ 2 callersMethod#updateRateLimitState
()
source/index.ts:863
↓ 2 callersMethodaddAll
( functions: ReadonlyArray<Task<TaskResultsType>>, options?: Partial<EnqueueOptionsType>, )
source/index.ts:584
↓ 2 callersMethodonError
()
source/index.ts:758
↓ 2 callersMethodonRateLimitCleared
@returns A promise that settles when the queue is no longer rate-limited.
source/index.ts:720
↓ 2 callersMethodremove
(idOrRun: string | RunFunction)
source/priority-queue.ts:63
↓ 1 callersMethod#consumeIntervalSlot
(now: number)
source/index.ts:163
↓ 1 callersMethod#createIntervalTimeout
(delay: number)
source/index.ts:256
↓ 1 callersMethod#isIntervalPausedAt
(now: number)
source/index.ts:222
↓ 1 callersMethod#next
()
source/index.ts:203
↓ 1 callersMethod#onResumeInterval
()
source/index.ts:214
↓ 1 callersMethod#rollbackIntervalConsumption
()
source/index.ts:854
↓ 1 callersMethod#rollbackIntervalSlot
()
source/index.ts:171
↓ 1 callersMethod#setupRateLimitTracking
()
source/index.ts:822
↓ 1 callersFunctionaddBenchmark
(name: string, fn: () => Promise<void>)
bench.ts:19
↓ 1 callersFunctionaddTask
(index: number)
test/rate-limit.ts:53
↓ 1 callersFunctionassertSlidingWindow
(executionTimes: number[], interval: number, intervalCap: number, jitterMilliseconds = Math.min(25, Math.trunc
test/strict.ts:6
↓ 1 callersFunctioncreateRun
(value: string)
test/priority-queue.ts:5
↓ 1 callersFunctioncreateTransitions
()
test/rate-limit.ts:283
↓ 1 callersFunctionlowerBound
(array: readonly T[], value: T, comparator: (a: T, b: T) => number)
source/lower-bound.ts:3
↓ 1 callersFunctionmonitorState
()
test/advanced.ts:1804
↓ 1 callersMethodonPendingZero
The difference with `.onIdle` is that `.onPendingZero` only waits for currently running tasks to finish, ignoring queued tasks. @returns A promise t
source/index.ts:698
↓ 1 callersMethodonSizeLessThan
@returns A promise that settles when the queue size is less than the given limit: `queue.size < limit`. If you want to avoid having the queue grow b
source/index.ts:667
↓ 1 callersMethodrun
()
source/index.ts:459
↓ 1 callersFunctionshouldRunBenchmark
(name: string)
bench.ts:16
↓ 1 callersMethodsizeBy
Size of the queue, filtered by the given options. For example, this can be used to find the number of items remaining in the queue with a specific p
source/index.ts:803
↓ 1 callersFunctionstartPauseCycles
()
test/rate-limit.ts:25
↓ 1 callersFunctionsuccessTask
()
test/strict.ts:721
↓ 1 callersFunctiontimeoutTask
()
test/strict.ts:708
Method#doesConcurrentAllowAnother
()
source/index.ts:199
Method#doesIntervalAllowAnother
()
source/index.ts:186
MethodcleanupQueueAbortHandler
()
source/index.ts:458
Methodconcurrency
()
source/index.ts:379
Methodconstructor
(options?: Options<QueueType, EnqueueOptionsType>)
source/index.ts:88
Functionfn
(deferred: Resolvable)
bench.ts:27
Functionfn
()
test/basic.ts:776
Functionfn1
()
test/basic.ts:789
Functionfn2
()
test/basic.ts:793
Functionfn3
()
test/basic.ts:797
MethodhandleError
(error: unknown)
source/index.ts:760
MethodisPaused
Whether the queue is currently paused.
source/index.ts:818
MethodisRateLimited
Whether the queue is currently rate-limited due to intervalCap.
source/index.ts:897
MethodisSaturated
Whether the queue is saturated. Returns `true` when: - All concurrency slots are occupied and tasks are waiting, OR - The queue is rate-limited and
source/index.ts:927
Methodlistener
()
source/index.ts:773
Functionmapper
([value, ms]: readonly number[])
test/basic.ts:47
Functionnoop
()
bench.ts:14
Methodpending
Number of running items (no longer in the queue).
source/index.ts:811
MethodqueueAbortHandler
()
source/index.ts:547
MethodremoveQueuedTask
()
source/index.ts:534
MethodrunningTasks
The tasks currently being executed. Each task includes its `id`, `priority`, `startTime`, `timeout` (if set), and `timeoutRemaining` (milliseconds unt
source/index.ts:963
MethodsetPriority
(id: string, priority: number)
source/priority-queue.ts:50
Methodsize
Size of the queue, the number of queued items waiting to run.
source/index.ts:794
Methodsize
()
source/priority-queue.ts:115