From 251a034c232ad870bec3da0903867867e14f29a4 Mon Sep 17 00:00:00 2001
From: manast
Date: Sat, 15 Jul 2023 20:56:57 +0000
Subject: [PATCH] deploy: bdaccd3aef8310a763169e3670cbbbd5288283e8
---
classes/v4.AsyncFifoQueue.html | 16 +--
classes/v4.Backoffs.html | 8 +-
classes/v4.ChildPool.html | 22 ++--
classes/v4.ChildProcessor.html | 18 +--
classes/v4.DelayedError.html | 4 +-
classes/v4.FlowProducer.html | 34 +++---
classes/v4.Job.html | 112 ++++++++---------
classes/v4.Queue.html | 120 +++++++++----------
classes/v4.QueueBase.html | 26 ++--
classes/v4.QueueEvents.html | 34 +++---
classes/v4.QueueGetters.html | 76 ++++++------
classes/v4.QueueKeys.html | 12 +-
classes/v4.RedisConnection.html | 22 ++--
classes/v4.Repeat.html | 36 +++---
classes/v4.ScriptLoader.html | 20 ++--
classes/v4.ScriptLoaderError.html | 10 +-
classes/v4.Scripts.html | 72 +++++------
classes/v4.UnrecoverableError.html | 4 +-
classes/v4.WaitingChildrenError.html | 4 +-
classes/v4.Worker.html | 60 +++++-----
enums/v4.ChildCommand.html | 8 +-
enums/v4.ClientType.html | 6 +-
enums/v4.ErrorCode.html | 14 +--
enums/v4.MetricsTime.html | 18 +--
enums/v4.ParentCommand.html | 18 +--
functions/v4.array2obj.html | 2 +-
functions/v4.asyncSend.html | 2 +-
functions/v4.childSend.html | 2 +-
functions/v4.delay.html | 2 +-
functions/v4.errorToJSON.html | 2 +-
functions/v4.getNextMillis.html | 2 +-
functions/v4.getParentKey.html | 2 +-
functions/v4.isEmpty.html | 2 +-
functions/v4.isNotConnectionError.html | 2 +-
functions/v4.isRedisCluster.html | 2 +-
functions/v4.isRedisInstance.html | 2 +-
functions/v4.isRedisVersionLowerThan.html | 2 +-
functions/v4.lengthInUtf8Bytes.html | 2 +-
functions/v4.parseObjectValues.html | 2 +-
functions/v4.raw2NextJobData.html | 2 +-
functions/v4.removeAllQueueData.html | 2 +-
functions/v4.tryCatch.html | 2 +-
interfaces/v4.AddChildrenOpts.html | 10 +-
interfaces/v4.AddNodeOpts.html | 10 +-
interfaces/v4.AdvancedOptions.html | 8 +-
interfaces/v4.AdvancedRepeatOptions.html | 6 +-
interfaces/v4.BackoffOptions.html | 6 +-
interfaces/v4.BaseJobOptions.html | 34 +++---
interfaces/v4.BaseOptions.html | 4 +-
interfaces/v4.BuiltInStrategies.html | 2 +-
interfaces/v4.ChildMessage.html | 8 +-
interfaces/v4.Command.html | 6 +-
interfaces/v4.DefaultJobOptions.html | 24 ++--
interfaces/v4.DependenciesOpts.html | 6 +-
interfaces/v4.FlowJobBase.html | 14 +--
interfaces/v4.FlowOpts.html | 4 +-
interfaces/v4.FlowProducerListener.html | 6 +-
interfaces/v4.GetNextJobOptions.html | 4 +-
interfaces/v4.IConnection.html | 6 +-
interfaces/v4.IoredisListener.html | 4 +-
interfaces/v4.JobJson.html | 32 ++---
interfaces/v4.JobJsonRaw.html | 34 +++---
interfaces/v4.JobNode.html | 6 +-
interfaces/v4.KeepJobs.html | 6 +-
interfaces/v4.Metrics.html | 8 +-
interfaces/v4.MetricsOptions.html | 4 +-
interfaces/v4.MinimalJob.html | 50 ++++----
interfaces/v4.MoveToWaitingChildrenOpts.html | 4 +-
interfaces/v4.NodeOpts.html | 12 +-
interfaces/v4.ObliterateOpts.html | 6 +-
interfaces/v4.Parent.html | 12 +-
interfaces/v4.ParentKeys.html | 6 +-
interfaces/v4.ParentMessage.html | 10 +-
interfaces/v4.QueueBaseOptions.html | 10 +-
interfaces/v4.QueueEventsListener.html | 38 +++---
interfaces/v4.QueueEventsOptions.html | 16 +--
interfaces/v4.QueueListener.html | 18 +--
interfaces/v4.QueueOptions.html | 16 +--
interfaces/v4.RateLimiterOptions.html | 6 +-
interfaces/v4.RawCommand.html | 8 +-
interfaces/v4.RepeatBaseOptions.html | 12 +-
interfaces/v4.RepeatOptions.html | 18 +--
interfaces/v4.SandboxedJob.html | 38 +++---
interfaces/v4.ScriptMetadata.html | 14 +--
interfaces/v4.WorkerListener.html | 28 ++---
interfaces/v4.WorkerOptions.html | 42 +++----
types/v4.BackoffStrategy.html | 2 +-
types/v4.BulkJobOptions.html | 2 +-
types/v4.ClusterOptions.html | 2 +-
types/v4.ConnectionOptions.html | 2 +-
types/v4.EntryId.html | 2 +-
types/v4.EntryRaw.html | 2 +-
types/v4.FinishedPropValAttribute.html | 2 +-
types/v4.FinishedStatus.html | 2 +-
types/v4.FlowChildJob.html | 2 +-
types/v4.FlowJob.html | 2 +-
types/v4.FlowQueuesOpts.html | 2 +-
types/v4.JobData.html | 2 +-
types/v4.JobJsonSandbox.html | 2 +-
types/v4.JobState.html | 2 +-
types/v4.JobType.html | 2 +-
types/v4.JobsOptions.html | 2 +-
types/v4.KeysMap.html | 2 +-
types/v4.MinimalQueue.html | 2 +-
types/v4.ParentOpts.html | 2 +-
types/v4.Processor.html | 2 +-
types/v4.RedisClient.html | 2 +-
types/v4.RedisJobOptions.html | 2 +-
types/v4.RedisOptions.html | 2 +-
types/v4.RepeatStrategy.html | 2 +-
types/v4.SandboxedJobProcessor.html | 2 +-
types/v4.StreamName.html | 2 +-
types/v4.StreamReadRaw.html | 2 +-
variables/v4.DELAY_TIME_1.html | 2 +-
variables/v4.DELAY_TIME_5.html | 2 +-
variables/v4.QUEUE_EVENT_SUFFIX.html | 2 +-
variables/v4.WORKER_SUFFIX.html | 2 +-
variables/v4.clientCommandMessageReg.html | 2 +-
variables/v4.errorObject.html | 2 +-
variables/v4.scriptLoader-1.html | 2 +-
120 files changed, 746 insertions(+), 746 deletions(-)
diff --git a/classes/v4.AsyncFifoQueue.html b/classes/v4.AsyncFifoQueue.html
index d39fc25259..297db68ba8 100644
--- a/classes/v4.AsyncFifoQueue.html
+++ b/classes/v4.AsyncFifoQueue.html
@@ -37,7 +37,7 @@ Hierarchy
+Defined in classes/async-fifo-queue.ts:13
@@ -75,7 +75,7 @@ Parameters
ignoreErrors: boolean = false
+Defined in classes/async-fifo-queue.ts:21
+Defined in classes/async-fifo-queue.ts:84
+Defined in classes/async-fifo-queue.ts:55
+Defined in classes/async-fifo-queue.ts:59
+Defined in classes/async-fifo-queue.ts:51
+Defined in classes/async-fifo-queue.ts:47
+Defined in classes/backoffs.ts:23
+Defined in classes/child-pool.ts:12
+Defined in classes/child-pool.ts:84
getFree
@@ -113,7 +113,7 @@ Parameters
id: string
Returns Child[]
+Defined in classes/child-pool.ts:80
kill
@@ -128,7 +128,7 @@ child: signal: "SIGKILL" | "SIGTERM" = 'SIGKILL'
Returns Promise<void>
+Defined in classes/child-pool.ts:64
release
@@ -141,7 +141,7 @@ Parameters
child: Child
Returns void
+Defined in classes/child-pool.ts:48
remove
@@ -154,7 +154,7 @@ Parameters
child: Child
Returns void
+Defined in classes/child-pool.ts:53
retain
@@ -167,7 +167,7 @@ Parameters
processFile: string
Returns Promise<Child>
+Defined in classes/child-pool.ts:23
Returns Promise<void>
+Defined in classes/child-processor.ts:66
+Defined in classes/child-processor.ts:94
waitForCurrentJobAndExit
@@ -136,7 +136,7 @@ waitForCurrentJobAnd
Returns Promise<void>
+Defined in classes/child-processor.ts:96
+Defined in classes/job.ts:149
delay
delay: number
@@ -187,7 +187,7 @@ Default Value
0
+Defined in classes/job.ts:85
failedReason
failedReason: string
@@ -196,7 +196,7 @@ failedReason
+Defined in classes/job.ts:101
Optional
finishedOn
finishedOn?: number
@@ -205,13 +205,13 @@ Optional
+Defined in classes/job.ts:106
+Defined in classes/job.ts:155
name
name: NameType
@@ -220,7 +220,7 @@ name
+Defined in classes/job.ts:144
opts
@@ -229,7 +229,7 @@ opts
+Defined in classes/job.ts:154
Optional
parent
@@ -238,7 +238,7 @@ Optional
+Defined in classes/job.ts:121
Optional
parentKey
parentKey?: string
@@ -247,7 +247,7 @@ Optional
+Defined in classes/job.ts:116
Optional
processedOn
processedOn?: number
@@ -256,7 +256,7 @@ Optional
+Defined in classes/job.ts:111
progress
progress: number | object = 0
@@ -267,7 +267,7 @@ Default Value
0
+Defined in classes/job.ts:67
Optional
repeatJobKey
repeatJobKey?: string
@@ -276,7 +276,7 @@ Optional
+Defined in classes/job.ts:126
returnvalue
returnvalue: ReturnType = null
@@ -287,7 +287,7 @@ Default Value
null
+Defined in classes/job.ts:73
stacktrace
stacktrace: string[] = null
@@ -298,7 +298,7 @@ Default Value
null
+Defined in classes/job.ts:79
timestamp
timestamp: number
@@ -307,7 +307,7 @@ timestamp
+Defined in classes/job.ts:90
Optional
token
token?: string
@@ -315,7 +315,7 @@ Optional
+Defined in classes/job.ts:131
queueName
@@ -339,7 +339,7 @@ Returns string
+Defined in classes/job.ts:702
+Defined in classes/job.ts:717
asJSON
@@ -384,7 +384,7 @@ Returns
+Defined in classes/job.ts:377
asJSONSandbox
@@ -396,7 +396,7 @@ Returns
+Defined in classes/job.ts:419
changeDelay
@@ -416,7 +416,7 @@ Returns Promise<
+Defined in classes/job.ts:737
changePriority
@@ -438,7 +438,7 @@ Returns Promise<
+Defined in classes/job.ts:747
clearLogs
@@ -457,7 +457,7 @@ Optional
Returns Promise<void>
+Defined in classes/job.ts:480
+Defined in classes/job.ts:1042
extendLock
@@ -492,7 +492,7 @@ duration: Returns Promise<number>
+Defined in classes/job.ts:516
getChildrenValues
@@ -509,7 +509,7 @@ Returns Promise<
+Defined in classes/job.ts:759
getDependencies
@@ -526,7 +526,7 @@ Returns Promise<
+Defined in classes/job.ts:776
getDependenciesCount
@@ -548,7 +548,7 @@ Returns Promise<
+Defined in classes/job.ts:868
getState
@@ -561,7 +561,7 @@ Returns Promise<
+Defined in classes/job.ts:727
isActive
@@ -571,7 +571,7 @@ Returns Promise<
+Defined in classes/job.ts:688
isCompleted
@@ -581,7 +581,7 @@ Returns Promise<
+Defined in classes/job.ts:660
isDelayed
@@ -591,7 +591,7 @@ Returns Promise<
+Defined in classes/job.ts:674
isFailed
@@ -601,7 +601,7 @@ Returns Promise<
+Defined in classes/job.ts:667
isWaiting
@@ -611,7 +611,7 @@ Returns Promise<
+Defined in classes/job.ts:695
isWaitingChildren
@@ -621,7 +621,7 @@ Returns Promise<
+Defined in classes/job.ts:681
log
@@ -641,7 +641,7 @@ Returns Promise<
+Defined in classes/job.ts:453
moveToCompleted
@@ -672,7 +672,7 @@ Returns Promise<
+Defined in classes/job.ts:529
moveToDelayed
@@ -696,7 +696,7 @@ Optional
Returns Promise<void>
+Defined in classes/job.ts:992
moveToFailed
@@ -731,7 +731,7 @@ Returns Promise<
+Defined in classes/job.ts:567
moveToWaitingChildren
@@ -756,7 +756,7 @@ Returns Promise<
+Defined in classes/job.ts:1003
+Defined in classes/job.ts:1013
+Defined in classes/job.ts:496
retry
@@ -802,7 +802,7 @@ Returns Promise<
+Defined in classes/job.ts:1030
+Defined in classes/job.ts:368
updateData
@@ -830,7 +830,7 @@ Returns Promise<
+Defined in classes/job.ts:432
updateProgress
@@ -850,7 +850,7 @@ Returns Promise<
+Defined in classes/job.ts:443
waitUntilFinished
@@ -875,7 +875,7 @@ Optional
Returns Promise<ReturnType>
+Defined in classes/job.ts:920
Static
create
@@ -918,7 +918,7 @@ Optional
Returns Promise<Job<T, R, N>>
+Defined in classes/job.ts:194
Static
createBulk
@@ -951,7 +951,7 @@ jobs: Returns Promise<Job<T, R, N>[]>
+Defined in classes/job.ts:221
Static
fromId
@@ -984,7 +984,7 @@ jobId: Returns Promise<Job<T, R, N>>
+Defined in classes/job.ts:350
Static
fromJSON
@@ -1022,7 +1022,7 @@ Optional
Returns Job<T, R, N>
+Defined in classes/job.ts:268
+Defined in classes/queue-base.ts:35
toKey
toKey: ((type) => string)
@@ -199,12 +199,12 @@ type: Returns string
+Defined in classes/queue-base.ts:19
token
token: string = ...
+Defined in classes/queue.ts:97
+Defined in classes/queue.ts:168
redisVersion
@@ -241,7 +241,7 @@ Returns string
+Defined in classes/queue-base.ts:84
+Defined in classes/queue.ts:172
Methods
@@ -280,7 +280,7 @@ Optional
Returns Promise<Job<DataType, ResultType, NameType>>
+Defined in classes/queue.ts:192
addBulk
@@ -301,7 +301,7 @@ jobs: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue.ts:232
clean
@@ -333,7 +333,7 @@ Returns Promise<
+Defined in classes/queue.ts:383
close
@@ -345,7 +345,7 @@ Returns Promise<
+Defined in classes/queue.ts:269
count
@@ -358,7 +358,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:96
disconnect
@@ -370,7 +370,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:144
drain
@@ -391,7 +391,7 @@ delayed: Returns Promise<void>
+Defined in classes/queue.ts:369
emit
@@ -418,7 +418,7 @@ Returns boolean
+Defined in classes/queue.ts:134
getActive
@@ -443,7 +443,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:229
getActiveCount
@@ -455,7 +455,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:175
getCompleted
@@ -480,7 +480,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:265
getCompletedCount
@@ -492,7 +492,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:154
getDelayed
@@ -517,7 +517,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:241
getDelayedCount
@@ -529,7 +529,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:168
getFailed
@@ -554,7 +554,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:277
getFailedCount
@@ -566,7 +566,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:161
getJob
@@ -580,7 +580,7 @@ jobId: Returns Promise<Job<DataType, ResultType, NameType>>
+Defined in classes/queue-getters.ts:26
getJobCountByTypes
@@ -601,7 +601,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:116
getJobCounts
@@ -619,7 +619,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:126
getJobLogs
@@ -654,7 +654,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:354
getJobState
@@ -673,7 +673,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:147
getJobs
@@ -708,7 +708,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:327
getMetrics
@@ -743,7 +743,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:442
getPrioritized
@@ -768,7 +768,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:253
getPrioritizedCount
@@ -780,7 +780,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:182
getQueueEvents
@@ -796,7 +796,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:420
getRanges
@@ -816,7 +816,7 @@ asc: Returns Promise<string[]>
+Defined in classes/queue-getters.ts:284
getRepeatableJobs
@@ -846,7 +846,7 @@ Optional
Returns Promise<{
endDate: number;
id: string;
key: string;
name: string;
next: number;
pattern: string;
tz: string;
}[]>
+Defined in classes/queue.ts:305
getWaiting
@@ -871,7 +871,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:205
getWaitingChildren
@@ -896,7 +896,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:217
getWaitingChildrenCount
@@ -908,7 +908,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:196
getWaitingCount
@@ -920,7 +920,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:189
getWorkers
@@ -937,7 +937,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:406
+Defined in classes/queue.ts:291
obliterate
@@ -972,7 +972,7 @@ Optional
Returns Promise<void>
+Defined in classes/queue.ts:416
off
@@ -993,7 +993,7 @@ listener: Returns Queue<DataType, ResultType, NameType>
+Defined in classes/queue.ts:141
on
@@ -1014,7 +1014,7 @@ listener: Returns Queue<DataType, ResultType, NameType>
+Defined in classes/queue.ts:149
once
@@ -1035,7 +1035,7 @@ listener: Returns Queue<DataType, ResultType, NameType>
+Defined in classes/queue.ts:157
+Defined in classes/queue.ts:260
remove
@@ -1074,7 +1074,7 @@ Returns Promise<
+Defined in classes/queue.ts:358
removeDeprecatedPriorityKey
@@ -1085,7 +1085,7 @@ removeDeprecatedPriorityKey<
Returns Promise<number>
+Defined in classes/queue.ts:462
removeRepeatable
@@ -1109,7 +1109,7 @@ Returns Promise<
See
removeRepeatableByKey
+Defined in classes/queue.ts:322
removeRepeatableByKey
@@ -1132,7 +1132,7 @@ Returns Promise<
See
getRepeatableJobs
+Defined in classes/queue.ts:343
+Defined in classes/queue.ts:283
retryJobs
@@ -1172,7 +1172,7 @@ Optional
Returns Promise<void>
+Defined in classes/queue.ts:436
trimEvents
@@ -1188,7 +1188,7 @@ maxLength: Returns Promise<number>
+Defined in classes/queue.ts:454
+Defined in classes/queue-base.ts:116
+Defined in classes/queue-base.ts:35
toKey
toKey: ((type) => string)
@@ -151,7 +151,7 @@ type: Returns string
+Defined in classes/queue-base.ts:19
redisVersion
@@ -177,7 +177,7 @@ Returns string
+Defined in classes/queue-base.ts:84
+Defined in classes/queue-base.ts:144
emit
@@ -223,7 +223,7 @@ Returns boolean
Implementation of MinimalQueue.emit
Overrides EventEmitter.emit
+Defined in classes/queue-base.ts:102
+Defined in classes/queue-base.ts:116
+Defined in classes/queue-base.ts:35
toKey
toKey: ((type) => string)
@@ -133,7 +133,7 @@ type: Returns string
+Defined in classes/queue-base.ts:19
redisVersion
@@ -159,7 +159,7 @@ Returns string
+Defined in classes/queue-base.ts:84
disconnect
@@ -185,7 +185,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:144
emit
@@ -212,7 +212,7 @@ Returns boolean
+Defined in classes/queue-events.ts:196
+Defined in classes/queue-events.ts:203
+Defined in classes/queue-events.ts:211
+Defined in classes/queue-events.ts:219
+Defined in classes/queue-events.ts:231
+Defined in classes/queue-base.ts:116
+Defined in classes/queue-base.ts:35
toKey
toKey: ((type) => string)
@@ -183,7 +183,7 @@ type: Returns string
+Defined in classes/queue-base.ts:19
redisVersion
@@ -209,7 +209,7 @@ Returns string
+Defined in classes/queue-base.ts:84
+Defined in classes/queue-getters.ts:96
disconnect
@@ -246,7 +246,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:144
emit
@@ -268,7 +268,7 @@ Returns boolean
+Defined in classes/queue-base.ts:102
getActive
@@ -292,7 +292,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:229
+Defined in classes/queue-getters.ts:175
getCompleted
@@ -327,7 +327,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:265
+Defined in classes/queue-getters.ts:154
getDelayed
@@ -362,7 +362,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:241
+Defined in classes/queue-getters.ts:168
getFailed
@@ -397,7 +397,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:277
+Defined in classes/queue-getters.ts:161
getJob
@@ -421,7 +421,7 @@ Parameters
jobId: string
Returns Promise<Job<DataType, ResultType, NameType>>
+Defined in classes/queue-getters.ts:26
getJobCountByTypes
@@ -441,7 +441,7 @@ Rest
Returns Promise<number>
+Defined in classes/queue-getters.ts:116
getJobCounts
@@ -458,7 +458,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:126
getJobLogs
@@ -492,7 +492,7 @@ asc: Returns Promise<{
count: number;
logs: string[];
}>
+Defined in classes/queue-getters.ts:354
getJobState
@@ -510,7 +510,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:147
getJobs
@@ -544,7 +544,7 @@ asc: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:327
getMetrics
@@ -578,7 +578,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:442
getPrioritized
@@ -602,7 +602,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:253
+Defined in classes/queue-getters.ts:182
getQueueEvents
@@ -628,7 +628,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:420
getRanges
@@ -647,7 +647,7 @@ end: asc: boolean = false
Returns Promise<string[]>
+Defined in classes/queue-getters.ts:284
getWaiting
@@ -671,7 +671,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:205
getWaitingChildren
@@ -695,7 +695,7 @@ end: Returns Promise<Job<DataType, ResultType, NameType>[]>
+Defined in classes/queue-getters.ts:217
getWaitingChildrenCount
@@ -706,7 +706,7 @@ getWaitingChildrenCountReturns Promise<number>
+Defined in classes/queue-getters.ts:196
+Defined in classes/queue-getters.ts:189
getWorkers
@@ -733,7 +733,7 @@ Returns Promise<
+Defined in classes/queue-getters.ts:406
+Defined in classes/queue-base.ts:116
Returns string
+Defined in classes/queue-keys.ts:41
toKey
@@ -105,7 +105,7 @@ name: type: string
Returns string
+Defined in classes/queue-keys.ts:37
+Defined in classes/queue-base.ts:19
redisVersion
@@ -159,7 +159,7 @@ Returns string
+Defined in classes/queue-base.ts:84
close
@@ -200,7 +200,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:133
disconnect
@@ -212,7 +212,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:144
emit
@@ -234,7 +234,7 @@ Returns boolean
+Defined in classes/queue-base.ts:102
+Defined in classes/repeat.ts:202
getRepeatableJobs
@@ -259,7 +259,7 @@ end: asc: boolean = false
Returns Promise<{
endDate: number;
id: string;
key: string;
name: string;
next: number;
pattern: string;
tz: string;
}[]>
+Defined in classes/repeat.ts:187
removeRepeatable
Returns Promise<number>
+Defined in classes/repeat.ts:143
removeRepeatableByKey
@@ -289,7 +289,7 @@ Parameters
repeatJobKey: string
Returns Promise<number>
+Defined in classes/repeat.ts:159
+Defined in classes/queue-base.ts:116
Returns Promise<void>
+Defined in classes/scripts.ts:533
cleanJobsInSet
@@ -168,7 +168,7 @@ Returns Promise<
+Defined in classes/scripts.ts:699
drain
@@ -181,7 +181,7 @@ Parameters
delayed: boolean
Returns Promise<void>
+Defined in classes/scripts.ts:367
extendLock
@@ -200,7 +200,7 @@ duration: Optional client: ChainableCommander | RedisClient
Returns Promise<number>
+Defined in classes/scripts.ts:190
finishedErrors
@@ -219,7 +219,7 @@ command: Optional state: string
Returns Error
+Defined in classes/scripts.ts:324
getCounts
@@ -232,7 +232,7 @@ Parameters
types: JobType[]
Returns Promise<number[]>
+Defined in classes/scripts.ts:417
getRanges
@@ -251,7 +251,7 @@ end: asc: boolean = false
Returns Promise<[string][]>
+Defined in classes/scripts.ts:392
getState
@@ -264,7 +264,7 @@ Parameters
jobId: string
Returns Promise<"unknown" | JobState>
+Defined in classes/scripts.ts:479
isFinished
@@ -279,7 +279,7 @@ jobId: returnValue: boolean = false
Returns Promise<number | [number, string]>
+Defined in classes/scripts.ts:464
isJobInList
@@ -294,7 +294,7 @@ listKey: jobId: string
Returns Promise<boolean>
+Defined in classes/scripts.ts:63
moveJobFromActiveToWait
@@ -317,7 +317,7 @@ token: Returns Promise<any>
+Defined in classes/scripts.ts:920
moveStalledJobsToWait
@@ -333,7 +333,7 @@ moveStalledJobsToWait<
Returns Promise<[string[], string[]]>
+Defined in classes/scripts.ts:888
moveToActive
@@ -348,7 +348,7 @@ token: Optional jobId: string
Returns Promise<any[]>
+Defined in classes/scripts.ts:825
moveToCompletedArgs
@@ -378,7 +378,7 @@ token: fetchNext: boolean = false
Returns (string | number | boolean | Buffer)[]
+Defined in classes/scripts.ts:424
moveToDelayed
@@ -395,7 +395,7 @@ timestamp: token: string = '0'
Returns Promise<void>
+Defined in classes/scripts.ts:644
moveToDelayedArgs
@@ -412,7 +412,7 @@ timestamp: token: string
Returns (string | number)[]
+Defined in classes/scripts.ts:569
moveToFailedArgs
@@ -442,7 +442,7 @@ token: fetchNext: boolean = false
Returns (string | number | boolean | Buffer)[]
+Defined in classes/scripts.ts:444
moveToFinished
@@ -457,7 +457,7 @@ jobId: args: (string | number | boolean | Buffer)[]
Returns Promise<any[]>
+Defined in classes/scripts.ts:308
+Defined in classes/scripts.ts:669
moveToWaitingChildrenArgs
Returns string[]
+Defined in classes/scripts.ts:621
obliterate
@@ -522,7 +522,7 @@ countforce: boolean
Returns Promise<number>
+Defined in classes/scripts.ts:943
pause
@@ -535,7 +535,7 @@ Parameters
pause: boolean
Returns Promise<void>
+Defined in classes/scripts.ts:141
promote
@@ -548,7 +548,7 @@ Parameters
jobId: string
Returns Promise<number>
+Defined in classes/scripts.ts:861
remove
@@ -561,7 +561,7 @@ Parameters
jobId: string
Returns Promise<number>
+Defined in classes/scripts.ts:183
removeRepeatable
@@ -576,7 +576,7 @@ repeatJobId: repeatJobKey: string
Returns Promise<number>
+Defined in classes/scripts.ts:173
reprocessJob
@@ -612,7 +612,7 @@ Returns Promise<
+Defined in classes/scripts.ts:793
retryJobArgs
@@ -629,7 +629,7 @@ lifo: token: string
Returns (string | number)[]
+Defined in classes/scripts.ts:716
retryJobs
@@ -646,7 +646,7 @@ count: timestamp: number = ...
Returns Promise<number>
+Defined in classes/scripts.ts:768
saveStacktraceArgs
@@ -663,7 +663,7 @@ stacktrace: failedReason: string
Returns string[]
+Defined in classes/scripts.ts:611
updateData
Returns Promise<void>
+Defined in classes/scripts.ts:207
updateProgress
Returns Promise<void>
+Defined in classes/scripts.ts:223
Returns void
+Defined in classes/worker.ts:347
redisVersion
@@ -210,7 +210,7 @@ Returns string
+Defined in classes/queue-base.ts:84
+Defined in classes/worker.ts:354
delay
@@ -259,7 +259,7 @@ Optional
Returns Promise<void>
+Defined in classes/worker.ts:570
disconnect
@@ -271,7 +271,7 @@ Returns Promise<
+Defined in classes/queue-base.ts:144
emit
@@ -298,7 +298,7 @@ Returns boolean
+Defined in classes/worker.ts:287
getNextJob
@@ -320,7 +320,7 @@ Returns Promise<
+Defined in classes/worker.ts:441
isPaused
@@ -332,7 +332,7 @@ Returns boolean
+Defined in classes/worker.ts:713
isRunning
@@ -344,7 +344,7 @@ Returns boolean
+Defined in classes/worker.ts:723
off
@@ -365,7 +365,7 @@ listener: Returns Worker<DataType, ResultType, NameType>
+Defined in classes/worker.ts:294
on
@@ -386,7 +386,7 @@ listener: Returns Worker<DataType, ResultType, NameType>
+Defined in classes/worker.ts:302
once
@@ -407,7 +407,7 @@ listener: Returns Worker<DataType, ResultType, NameType>
+Defined in classes/worker.ts:310
pause
@@ -423,7 +423,7 @@ Optional
Returns Promise<void>
+Defined in classes/worker.ts:682
processJob
@@ -448,7 +448,7 @@ Returns boolean
jobsInProgress: Set<{
job: Job<any, any, string>;
ts: number;
}>
Returns Promise<void | Job<DataType, ResultType, NameType>>
+Defined in classes/worker.ts:606
rateLimit
@@ -467,7 +467,7 @@ expireTimeMs: Returns Promise<void>
+Defined in classes/worker.ts:489
+Defined in classes/worker.ts:700
+Defined in classes/worker.ts:368
+Defined in classes/worker.ts:786
waitUntilReady
@@ -518,7 +518,7 @@ Returns Promise<
+Defined in classes/worker.ts:342
Static
RateLimitError
@@ -526,7 +526,7 @@ Static
Returns Error
+Defined in classes/worker.ts:189
+Defined in interfaces/advanced-options.ts:7
+Defined in interfaces/base-job-options.ts:64
+Defined in interfaces/base-job-options.ts:41
Optional
parent
parent?: {
id: string;
queue: string;
}
@@ -131,7 +131,7 @@ queuehttps://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+Defined in interfaces/base-job-options.ts:100
Optional
prevMillis
prevMillis?: number
@@ -139,7 +139,7 @@ Optional
+Defined in interfaces/base-job-options.ts:113
Optional
priority
priority?: number
@@ -150,7 +150,7 @@ Optional
+Defined in interfaces/base-job-options.ts:15
Optional
removeOnComplete
removeOnComplete?: number | boolean | KeepJobs
@@ -163,7 +163,7 @@ Optional
+Defined in interfaces/base-job-options.ts:50
Optional
removeOnFail
removeOnFail?: number | boolean | KeepJobs
@@ -176,7 +176,7 @@ Optional
+Defined in interfaces/base-job-options.ts:59
Optional
repeat
@@ -184,7 +184,7 @@ Optional
+Defined in interfaces/base-job-options.ts:81
Optional
repeatJobKey
repeatJobKey?: string
@@ -192,7 +192,7 @@ Optional
+Defined in interfaces/base-job-options.ts:86
Optional
sizeLimit
sizeLimit?: number
@@ -201,7 +201,7 @@ Optional
+Defined in interfaces/base-job-options.ts:74
Optional
stackTraceLimit
stackTraceLimit?: number
@@ -210,7 +210,7 @@ Optional
+Defined in interfaces/base-job-options.ts:69
Optional
timestamp
timestamp?: number
@@ -221,7 +221,7 @@ Default Value
Date.now()
+Defined in interfaces/base-job-options.ts:8
+Defined in interfaces/base-job-options.ts:8
+Defined in interfaces/minimal-job.ts:19
+Defined in interfaces/ioredis-events.ts:7
+Defined in interfaces/minimal-job.ts:120
+Defined in classes/queue-events.ts:69
error
error: ((args) => void)
@@ -269,7 +269,7 @@ args: Returns void
+Defined in classes/queue-events.ts:76
failed
failed: ((args, id) => void)
@@ -300,7 +300,7 @@ id: Returns void
+Defined in classes/queue-events.ts:83
ioredis:close
ioredis:close: (() => void)
@@ -318,7 +318,7 @@ Returns void
+Defined in interfaces/ioredis-events.ts:7
paused
paused: ((args, id) => void)
@@ -343,7 +343,7 @@ id: Returns void
+Defined in classes/queue-events.ts:93
progress
progress: ((args, id) => void)
@@ -375,7 +375,7 @@ id: Returns void
+Defined in classes/queue-events.ts:103
removed
removed: ((args, id) => void)
@@ -405,7 +405,7 @@ id: Returns void
+Defined in classes/queue-events.ts:114
resumed
resumed: ((args, id) => void)
@@ -430,7 +430,7 @@ id: Returns void
+Defined in classes/queue-events.ts:121
retries-exhausted
retries-exhausted: ((args, id) => void)
@@ -459,7 +459,7 @@ id: Returns void
+Defined in classes/queue-events.ts:128
stalled
stalled: ((args, id) => void)
@@ -488,7 +488,7 @@ id: Returns void
+Defined in classes/queue-events.ts:140
waiting
waiting: ((args, id) => void)
@@ -517,7 +517,7 @@ id: Returns void
+Defined in classes/queue-events.ts:147
waiting-children
waiting-children: ((args, id) => void)
@@ -544,7 +544,7 @@ id: Returns void
+Defined in classes/queue-events.ts:154
+Defined in interfaces/queue-options.ts:32
Optional
sharedConnection
sharedConnection?: boolean
@@ -106,7 +106,7 @@ Optional
+Defined in interfaces/queue-options.ts:22
+Defined in interfaces/ioredis-events.ts:7
paused
paused: (() => void)
@@ -131,7 +131,7 @@ Type declaration
Returns void
+Defined in classes/queue.ts:51
progress
progress: ((job, progress) => void)
@@ -155,7 +155,7 @@ progress: Returns void
+Defined in classes/queue.ts:58
removed
removed: ((job) => void)
@@ -177,7 +177,7 @@ job: Returns void
+Defined in classes/queue.ts:68
resumed
resumed: (() => void)
@@ -194,7 +194,7 @@ Type declaration
Returns void
+Defined in classes/queue.ts:75
waiting
waiting: ((job) => void)
@@ -216,7 +216,7 @@ job: Returns void
+Defined in classes/queue.ts:82
+Defined in interfaces/queue-options.ts:32
+Defined in interfaces/queue-options.ts:56
Optional
sharedConnection
sharedConnection?: boolean
@@ -90,7 +90,7 @@ Optional
+Defined in interfaces/queue-options.ts:22
Optional
streams
streams?: {
events: {
maxLen: number;
};
}
@@ -112,7 +112,7 @@ maxLen
+Defined in interfaces/queue-options.ts:44
+Defined in interfaces/queue-options.ts:22
Returns Promise<void>
+Defined in interfaces/sandboxed-job.ts:13
updateProgress
updateProgress: ((value) => Promise<void>)
@@ -203,7 +203,7 @@ Parameters
value: number | object
Returns Promise<void>
+Defined in interfaces/sandboxed-job.ts:11
+Defined in commands/script-loader.ts:37
token
token: string
@@ -87,7 +87,7 @@ token
+Defined in commands/script-loader.ts:45
+Defined in classes/worker.ts:62
completed
completed: ((job, result, prev) => void)
@@ -144,7 +144,7 @@ prev: Returns void
+Defined in classes/worker.ts:69
drained
drained: (() => void)
@@ -163,7 +163,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:82
error
error: ((failedReason) => void)
@@ -185,7 +185,7 @@ failedReason: Returns void
+Defined in classes/worker.ts:89
failed
failed: ((job, error, prev) => void)
@@ -213,7 +213,7 @@ prev: Returns void
+Defined in classes/worker.ts:98
ioredis:close
ioredis:close: (() => void)
@@ -231,7 +231,7 @@ Returns void
+Defined in interfaces/ioredis-events.ts:7
paused
paused: (() => void)
@@ -248,7 +248,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:109
progress
progress: ((job, progress) => void)
@@ -275,7 +275,7 @@ progress: Returns void
+Defined in classes/worker.ts:119
ready
ready: (() => void)
@@ -292,7 +292,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:129
resumed
resumed: (() => void)
@@ -309,7 +309,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:136
stalled
stalled: ((jobId, prev) => void)
@@ -334,7 +334,7 @@ prev: Returns void
+Defined in classes/worker.ts:144
+Defined in interfaces/worker-options.ts:31
Optional
connection
@@ -100,7 +100,7 @@ Optional
+Defined in interfaces/queue-options.ts:17
Optional
drainDelay
drainDelay?: number
@@ -111,7 +111,7 @@ Default
5
+Defined in interfaces/worker-options.ts:99
+Defined in interfaces/worker-options.ts:37
Optional
lockDuration
lockDuration?: number
@@ -135,7 +135,7 @@ Default
30000
+Defined in interfaces/worker-options.ts:110
Optional
lockRenewTime
lockRenewTime?: number
@@ -145,7 +145,7 @@ Optional
+Defined in interfaces/worker-options.ts:118
Optional
maxStalledCount
maxStalledCount?: number
@@ -158,7 +158,7 @@ Default
1
+Defined in interfaces/worker-options.ts:52
+Defined in interfaces/worker-options.ts:43
Optional
prefix
prefix?: string
@@ -177,7 +177,7 @@ Optional
+Defined in interfaces/queue-options.ts:32
Optional
removeOnComplete
@@ -187,7 +187,7 @@ Optional
+Defined in interfaces/worker-options.ts:66
Optional
removeOnFail
@@ -197,7 +197,7 @@ Optional
+Defined in interfaces/worker-options.ts:73
Optional
runRetryDelay
runRetryDelay?: number
@@ -208,7 +208,7 @@ Default
15000
+Defined in interfaces/worker-options.ts:125
Optional
settings
@@ -216,7 +216,7 @@ Optional
+Defined in interfaces/worker-options.ts:130
Optional
sharedConnection
sharedConnection?: boolean
@@ -225,7 +225,7 @@ Optional
+Defined in interfaces/queue-options.ts:22
Optional
skipLockRenewal
skipLockRenewal?: boolean
@@ -238,7 +238,7 @@ Default
false
+Defined in interfaces/worker-options.ts:91
Optional
skipStalledCheck
skipStalledCheck?: boolean
@@ -251,7 +251,7 @@ Default
false
+Defined in interfaces/worker-options.ts:82
Optional
stalledInterval
stalledInterval?: number
@@ -262,7 +262,7 @@ Default
30000
+Defined in interfaces/worker-options.ts:59
Optional
useWorkerThreads
useWorkerThreads?: boolean
@@ -275,7 +275,7 @@ Default
false
+Defined in interfaces/worker-options.ts:139
+Defined in types/backoff-strategy.ts:3
+Defined in types/job-options.ts:3
+Defined in types/job-options.ts:13
+Defined in types/repeat-strategy.ts:3