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

    Returns AsyncFifoQueue<T>

    +
  • Defined in classes/async-fifo-queue.ts:21
  • Methods

    @@ -90,7 +90,7 @@

    Parameters

    promise: Promise<T>

    Returns void

    +
  • Defined in classes/async-fifo-queue.ts:25
  • +
  • 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
  • Returns BackoffOptions

    +
  • Defined in classes/backoffs.ts:23
  • +
  • Defined in classes/child-pool.ts:13
  • retained: {
        [key: number]: Child;
    } = {}
    @@ -82,7 +82,7 @@

    Type declaration

  • [key: number]: Child
  • +
  • Defined in classes/child-pool.ts:12
  • Methods

    @@ -92,7 +92,7 @@
    +
  • Defined in classes/child-pool.ts:72
  • +
  • Defined in classes/child-pool.ts:84
  • Returns Child[]

    +
  • Defined in classes/child-pool.ts:80
  • Returns Promise<void>

    +
  • Defined in classes/child-pool.ts:64
  • Returns void

    +
  • Defined in classes/child-pool.ts:48
  • Returns void

    +
  • Defined in classes/child-pool.ts:53
  • Returns Promise<Child>

    +
  • Defined in classes/child-pool.ts:23
  • Returns Promise<void>

    +
  • Defined in classes/child-processor.ts:26
    • @@ -120,7 +120,7 @@

      Parameters

      jobJson: JobJson

    Returns Promise<void>

    +
  • Defined in classes/child-processor.ts:66
  • +
  • Defined in classes/child-processor.ts:94
  • +
  • Defined in classes/child-processor.ts:96
  • +
  • Defined in classes/flow-producer.ts:93
  • Accessors

    @@ -135,7 +135,7 @@
    +
  • Defined in classes/flow-producer.ts:210
  • Methods

    @@ -164,7 +164,7 @@
    Optional Returns Promise<JobNode>
    +
  • Defined in classes/flow-producer.ts:159
  • +
  • Defined in classes/flow-producer.ts:235
  • +
  • Defined in classes/flow-producer.ts:445
  • +
  • Defined in classes/flow-producer.ts:452
  • +
  • Defined in classes/flow-producer.ts:118
  • +
  • Defined in classes/flow-producer.ts:192
  • +
  • Defined in classes/flow-producer.ts:125
  • +
  • Defined in classes/flow-producer.ts:133
  • +
  • Defined in classes/flow-producer.ts:141
  • +
  • Defined in classes/job.ts:96
  • data: DataType
    @@ -176,7 +176,7 @@
    +
  • Defined in classes/job.ts:149
  • delay: number
    @@ -187,7 +187,7 @@

    Default Value

    0

    +
  • Defined in classes/job.ts:85
  • failedReason: string
    @@ -196,7 +196,7 @@
    +
  • Defined in classes/job.ts:101
  • finishedOn?: number
    @@ -205,13 +205,13 @@
    +
  • Defined in classes/job.ts:106
  • id?: string
    +
  • Defined in classes/job.ts:155
  • name: NameType
    @@ -220,7 +220,7 @@
    +
  • Defined in classes/job.ts:144
  • opts: JobsOptions = {}
    @@ -229,7 +229,7 @@
    +
  • Defined in classes/job.ts:154
  • parent?: ParentKeys
    @@ -238,7 +238,7 @@
    +
  • Defined in classes/job.ts:121
  • parentKey?: string
    @@ -247,7 +247,7 @@
    +
  • Defined in classes/job.ts:116
  • processedOn?: number
    @@ -256,7 +256,7 @@
    +
  • Defined in classes/job.ts:111
  • progress: number | object = 0
    @@ -267,7 +267,7 @@

    Default Value

    0

    +
  • Defined in classes/job.ts:67
  • repeatJobKey?: string
    @@ -276,7 +276,7 @@
    +
  • Defined in classes/job.ts:126
  • returnvalue: ReturnType = null
    @@ -287,7 +287,7 @@

    Default Value

    null

    +
  • Defined in classes/job.ts:73
  • stacktrace: string[] = null
    @@ -298,7 +298,7 @@

    Default Value

    null

    +
  • Defined in classes/job.ts:79
  • timestamp: number
    @@ -307,7 +307,7 @@
    +
  • Defined in classes/job.ts:90
  • token?: string
    @@ -315,7 +315,7 @@
    +
  • Defined in classes/job.ts:131
  • Accessors

    @@ -328,7 +328,7 @@

    Returns string

    +
  • Defined in classes/job.ts:709
  • +
  • Defined in classes/job.ts:702
  • +
  • Defined in classes/job.ts:717
  • Methods

    @@ -372,7 +372,7 @@
    Optional Returns Promise<string>
    +
  • Defined in classes/job.ts:1064
  • +
  • Defined in classes/job.ts:377
  • +
  • Defined in classes/job.ts:419
  • +
  • Defined in classes/job.ts:737
  • +
  • Defined in classes/job.ts:747
  • +
  • Defined in classes/job.ts:480
  • +
  • Defined in classes/job.ts:1042
  • +
  • Defined in classes/job.ts:516
  • +
  • Defined in classes/job.ts:759
  • +
  • Defined in classes/job.ts:776
  • +
  • Defined in classes/job.ts:868
  • +
  • Defined in classes/job.ts:727
  • +
  • Defined in classes/job.ts:688
  • +
  • Defined in classes/job.ts:660
  • +
  • Defined in classes/job.ts:674
  • +
  • Defined in classes/job.ts:667
  • +
  • Defined in classes/job.ts:695
  • +
  • Defined in classes/job.ts:681
  • +
  • Defined in classes/job.ts:453
  • +
  • Defined in classes/job.ts:529
  • +
  • Defined in classes/job.ts:992
  • +
  • Defined in classes/job.ts:567
  • +
  • Defined in classes/job.ts:1003
  • +
  • Defined in classes/job.ts:1013
  • +
  • Defined in classes/job.ts:496
  • +
  • Defined in classes/job.ts:1030
  • +
  • Defined in classes/job.ts:368
  • +
  • Defined in classes/job.ts:432
  • +
  • Defined in classes/job.ts:443
  • +
  • Defined in classes/job.ts:920
  • +
  • Defined in classes/job.ts:194
  • +
  • Defined in classes/job.ts:221
  • +
  • Defined in classes/job.ts:350
  • +
  • Defined in classes/job.ts:268
  • +
  • Defined in classes/queue-base.ts:34
  • opts: QueueBaseOptions = {}
    @@ -180,7 +180,7 @@
    +
  • Defined in classes/queue-base.ts:35
  • toKey: ((type) => string)
    @@ -199,12 +199,12 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • token: string = ...
    +
  • Defined in classes/queue.ts:97
  • Accessors

    @@ -218,7 +218,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
  • +
  • Defined in classes/queue.ts:168
  • +
  • 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
  • +
  • Defined in classes/queue.ts:232
  • +
  • Defined in classes/queue.ts:383
  • +
  • Defined in classes/queue.ts:269
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • Defined in classes/queue.ts:369
  • +
  • Defined in classes/queue.ts:134
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:175
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:154
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:168
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:161
  • +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:116
  • +
  • Defined in classes/queue-getters.ts:126
  • +
  • Defined in classes/queue-getters.ts:354
  • +
  • Defined in classes/queue-getters.ts:147
  • +
  • Defined in classes/queue-getters.ts:327
  • +
  • Defined in classes/queue-getters.ts:442
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:182
  • +
  • Defined in classes/queue-getters.ts:420
  • +
  • Defined in classes/queue-getters.ts:284
  • +
  • Defined in classes/queue.ts:305
  • +
  • Defined in classes/queue-getters.ts:205
  • +
  • Defined in classes/queue-getters.ts:217
  • +
  • Defined in classes/queue-getters.ts:196
  • +
  • Defined in classes/queue-getters.ts:189
  • +
  • Defined in classes/queue-getters.ts:406
  • +
  • Defined in classes/queue.ts:291
  • +
  • Defined in classes/queue.ts:416
  • +
  • Defined in classes/queue.ts:141
  • +
  • Defined in classes/queue.ts:149
  • +
  • Defined in classes/queue.ts:157
  • +
  • Defined in classes/queue.ts:260
  • +
  • Defined in classes/queue.ts:358
  • +
  • Defined in classes/queue.ts:462
  • +
  • Defined in classes/queue.ts:322
  • +
  • Defined in classes/queue.ts:343
  • +
  • Defined in classes/queue.ts:283
  • +
  • Defined in classes/queue.ts:436
  • +
  • Defined in classes/queue.ts:454
  • +
  • Defined in classes/queue-base.ts:116
  • +
  • Defined in classes/queue-base.ts:34
  • opts: QueueBaseOptions = {}
    @@ -132,7 +132,7 @@
    +
  • Defined in classes/queue-base.ts:35
  • toKey: ((type) => string)
    @@ -151,7 +151,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • Accessors

    @@ -165,7 +165,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
  • +
  • Defined in classes/queue-base.ts:84
  • Methods

    @@ -189,7 +189,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:133
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • Defined in classes/queue-base.ts:102
  • +
  • Defined in classes/queue-base.ts:116
  • +
  • Defined in classes/queue-base.ts:34
  • opts: QueueBaseOptions = {}
    @@ -114,7 +114,7 @@
    +
  • Defined in classes/queue-base.ts:35
  • toKey: ((type) => string)
    @@ -133,7 +133,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • Accessors

    @@ -147,7 +147,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
  • +
  • Defined in classes/queue-base.ts:84
  • Methods

    @@ -173,7 +173,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-events.ts:304
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • 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:34
  • opts: QueueBaseOptions = {}
    @@ -164,7 +164,7 @@
    +
  • Defined in classes/queue-base.ts:35
  • toKey: ((type) => string)
    @@ -183,7 +183,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • Accessors

    @@ -197,7 +197,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
  • +
  • Defined in classes/queue-base.ts:84
  • Methods

    @@ -222,7 +222,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:133
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • Defined in classes/queue-base.ts:102
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:175
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:154
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:168
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:161
  • Returns Promise<Job<DataType, ResultType, NameType>>

    +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:116
  • +
  • Defined in classes/queue-getters.ts:126
  • +
  • Defined in classes/queue-getters.ts:354
  • +
  • Defined in classes/queue-getters.ts:147
  • +
  • Defined in classes/queue-getters.ts:327
  • +
  • Defined in classes/queue-getters.ts:442
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:182
  • +
  • Defined in classes/queue-getters.ts:420
  • Returns Promise<string[]>

    +
  • Defined in classes/queue-getters.ts:284
  • +
  • Defined in classes/queue-getters.ts:205
  • +
  • Defined in classes/queue-getters.ts:217
  • +
  • Defined in classes/queue-getters.ts:196
  • +
  • Defined in classes/queue-getters.ts:189
  • +
  • Defined in classes/queue-getters.ts:406
  • +
  • Defined in classes/queue-base.ts:116
  • Returns KeysMap

    +
  • Defined in classes/queue-keys.ts:6
    • @@ -90,7 +90,7 @@

      Parameters

      name: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:41
  • Returns string

    +
  • Defined in classes/queue-keys.ts:37
  • +
  • Defined in classes/queue-base.ts:34
  • opts: QueueBaseOptions = {}
    @@ -114,7 +114,7 @@
    +
  • Defined in classes/queue-base.ts:35
  • toKey: ((type) => string)
    @@ -133,7 +133,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • Accessors

    @@ -147,7 +147,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
  • +
  • Defined in classes/queue-base.ts:84
  • Methods

    @@ -189,7 +189,7 @@
    opts: Optional skipCheckExists: boolean

    Returns Promise<Job<T, R, N>>

    +
  • Defined in classes/repeat.ts:27
  • +
  • Defined in classes/queue-base.ts:133
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • Defined in classes/queue-base.ts:102
  • +
  • Defined in classes/repeat.ts:202
  • Returns Promise<{
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[]>

    +
  • Defined in classes/repeat.ts:187
  • Returns Promise<number>

    +
  • Defined in classes/repeat.ts:143
  • Returns Promise<number>

    +
  • Defined in classes/repeat.ts:159
  • +
  • Defined in classes/queue-base.ts:116
  • +
  • Defined in commands/script-loader.ts:134
  • Returns Promise<string>

    +
  • Defined in classes/scripts.ts:74
    • @@ -130,7 +130,7 @@
      jobId: delay: number

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:501
    • @@ -147,7 +147,7 @@
      priority: lifo: boolean = false

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:533
  • +
  • Defined in classes/scripts.ts:699
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:367
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:190
  • Returns Error

    +
  • Defined in classes/scripts.ts:324
  • Returns Promise<number[]>

    +
  • Defined in classes/scripts.ts:417
  • Returns Promise<[string][]>

    +
  • Defined in classes/scripts.ts:392
  • Returns Promise<"unknown" | JobState>

    +
  • Defined in classes/scripts.ts:479
  • Returns Promise<number | [number, string]>

    +
  • Defined in classes/scripts.ts:464
  • Returns Promise<boolean>

    +
  • Defined in classes/scripts.ts:63
  • +
  • Defined in classes/scripts.ts:920
  • +
  • Defined in classes/scripts.ts:888
  • Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:825
  • Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:424
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:644
  • Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:569
  • Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:444
  • Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:308
  • +
  • Defined in classes/scripts.ts:669
  • Returns string[]

    +
  • Defined in classes/scripts.ts:621
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:943
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:141
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:861
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:183
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:173
  • +
  • Defined in classes/scripts.ts:793
  • Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:716
  • Returns Promise<number>

    +
  • Defined in classes/scripts.ts:768
  • Returns string[]

    +
  • Defined in classes/scripts.ts:611
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:207
  • Returns Promise<void>

    +
  • Defined in classes/scripts.ts:223
  • +
  • Defined in classes/queue-base.ts:34
  • @@ -152,7 +152,7 @@
    +
  • Defined in classes/worker.ts:161
  • toKey: ((type) => string)
    @@ -171,7 +171,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:19
  • Accessors

    @@ -185,7 +185,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:77
    • @@ -198,7 +198,7 @@

      Parameters

      concurrency: number

    Returns void

    +
  • Defined in classes/worker.ts:347
  • +
  • Defined in classes/queue-base.ts:84
  • +
  • Defined in classes/worker.ts:354
  • Methods

    @@ -243,7 +243,7 @@

    Returns Promise<

    +
  • Defined in classes/worker.ts:738
  • +
  • Defined in classes/worker.ts:570
  • +
  • Defined in classes/queue-base.ts:144
  • +
  • Defined in classes/worker.ts:287
  • +
  • Defined in classes/worker.ts:441
  • +
  • Defined in classes/worker.ts:713
  • +
  • Defined in classes/worker.ts:723
  • +
  • Defined in classes/worker.ts:294
  • +
  • Defined in classes/worker.ts:302
  • +
  • Defined in classes/worker.ts:310
  • +
  • Defined in classes/worker.ts:682
  • Returns Promise<void | Job<DataType, ResultType, NameType>>

    +
  • Defined in classes/worker.ts:606
  • +
  • Defined in classes/worker.ts:489
  • +
  • Defined in classes/worker.ts:700
  • +
  • Defined in classes/worker.ts:368
  • +
  • Defined in classes/worker.ts:786
  • +
  • Defined in classes/worker.ts:342
  • +
  • Defined in classes/worker.ts:189
  • +
  • Defined in interfaces/child-command.ts:4
  • +
  • Defined in interfaces/queue-options.ts:7
  • +
  • Defined in enums/error-code.enum.ts:6
  • +
  • Defined in enums/metrics-time.ts:8
  • +
  • Defined in interfaces/parent-command.ts:9
  • +
  • Defined in utils.ts:41
  • +
  • Defined in utils.ts:127
  • +
  • Defined in utils.ts:148
  • +
  • Defined in utils.ts:49
  • +
  • Defined in utils.ts:173
  • +
  • Defined in classes/repeat.ts:234
  • +
  • Defined in utils.ts:98
  • +
  • Defined in utils.ts:32
  • +
  • Defined in utils.ts:114
  • +
  • Defined in utils.ts:63
  • +
  • Defined in utils.ts:55
  • +
  • Defined in utils.ts:153
  • +
  • Defined in utils.ts:28
  • +
  • Defined in utils.ts:162
  • +
  • Defined in classes/scripts.ts:965
  • +
  • Defined in utils.ts:67
  • +
  • Defined in utils.ts:10
  • +
  • Defined in classes/flow-producer.ts:44
  • +
  • Defined in classes/flow-producer.ts:31
  • +
  • Defined in interfaces/advanced-options.ts:7
  • +
  • Defined in interfaces/backoff-options.ts:10
  • +
  • Defined in interfaces/base-job-options.ts:34
  • delay?: number
    @@ -82,7 +82,7 @@

    Default Value

    0

    +
  • Defined in interfaces/base-job-options.ts:23
  • jobId?: string
    @@ -94,7 +94,7 @@
    +
  • Defined in interfaces/base-job-options.ts:95
  • keepLogs?: number
    @@ -103,7 +103,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -114,7 +114,7 @@

    See

    https://docs.bul

    +
  • Defined in interfaces/base-job-options.ts:41
  • 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
  • prevMillis?: number
    @@ -139,7 +139,7 @@
    +
  • Defined in interfaces/base-job-options.ts:113
  • priority?: number
    @@ -150,7 +150,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -163,7 +163,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -176,7 +176,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • repeat?: RepeatOptions
    @@ -184,7 +184,7 @@
    +
  • Defined in interfaces/base-job-options.ts:81
  • repeatJobKey?: string
    @@ -192,7 +192,7 @@
    +
  • Defined in interfaces/base-job-options.ts:86
  • sizeLimit?: number
    @@ -201,7 +201,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -210,7 +210,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -221,7 +221,7 @@

    Default Value

    Date.now()

    +
  • Defined in interfaces/base-job-options.ts:8
  • +
  • Defined in classes/backoffs.ts:4
  • +
  • Defined in commands/script-loader.ts:17
  • +
  • Defined in interfaces/base-job-options.ts:23
  • keepLogs?: number
    @@ -83,7 +83,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -93,7 +93,7 @@

    https://docs.bullmq.io/guide/jobs/lifo

    +
  • Defined in interfaces/base-job-options.ts:41
  • priority?: number
    @@ -103,7 +103,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -115,7 +115,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -127,7 +127,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • sizeLimit?: number
    @@ -135,7 +135,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -143,7 +143,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -153,7 +153,7 @@

    Date.now()

    +
  • Defined in interfaces/base-job-options.ts:8
  • +
  • Defined in interfaces/minimal-job.ts:19
  • +
  • Defined in interfaces/flow-job.ts:26
  • +
  • Defined in interfaces/ioredis-events.ts:7
  • +
  • Defined in interfaces/ioredis-events.ts:7
  • +
  • Defined in interfaces/metrics.ts:2
  • +
  • Defined in interfaces/minimal-job.ts:78
  • finishedOn?: number
    @@ -123,12 +123,12 @@
    +
  • Defined in interfaces/minimal-job.ts:82
  • id?: string
    +
  • Defined in interfaces/minimal-job.ts:45
  • name: NameType
    @@ -136,7 +136,7 @@
    +
  • Defined in interfaces/minimal-job.ts:36
  • @@ -144,7 +144,7 @@
    +
  • Defined in interfaces/minimal-job.ts:44
  • parent?: ParentKeys
    @@ -152,7 +152,7 @@
    +
  • Defined in interfaces/minimal-job.ts:94
  • parentKey?: string
    @@ -160,7 +160,7 @@
    +
  • Defined in interfaces/minimal-job.ts:90
  • processedOn?: number
    @@ -168,7 +168,7 @@
    +
  • Defined in interfaces/minimal-job.ts:86
  • progress: number | object
    @@ -178,7 +178,7 @@

    0

    +
  • Defined in interfaces/minimal-job.ts:50
  • repeatJobKey?: string
    @@ -186,7 +186,7 @@
    +
  • Defined in interfaces/minimal-job.ts:98
  • returnvalue: ReturnType
    @@ -196,7 +196,7 @@

    null

    +
  • Defined in interfaces/minimal-job.ts:55
  • stacktrace: string[]
    @@ -206,7 +206,7 @@

    null

    +
  • Defined in interfaces/minimal-job.ts:60
  • timestamp: number
    @@ -214,7 +214,7 @@
    +
  • Defined in interfaces/minimal-job.ts:69
  • Accessors

    @@ -226,7 +226,7 @@

    Returns string

    +
  • Defined in interfaces/minimal-job.ts:131
  • +
  • Defined in interfaces/minimal-job.ts:127
  • +
  • Defined in interfaces/minimal-job.ts:136
  • Methods

    @@ -259,7 +259,7 @@
    +
  • Defined in interfaces/minimal-job.ts:103
  • +
  • Defined in interfaces/minimal-job.ts:108
  • +
  • Defined in interfaces/minimal-job.ts:126
  • +
  • Defined in interfaces/minimal-job.ts:114
  • +
  • Defined in interfaces/minimal-job.ts:120
  • +
  • Defined in interfaces/minimal-job.ts:8
  • +
  • Defined in classes/queue.ts:22
  • +
  • Defined in classes/queue-events.ts:29
  • cleaned: ((args, id) => void)
    @@ -136,7 +136,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:36
  • completed: ((args, id) => void)
    @@ -167,7 +167,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:43
  • delayed: ((args, id) => void)
    @@ -196,7 +196,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:53
  • drained: ((id) => void)
    @@ -220,7 +220,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:62
  • duplicated: ((args, id) => void)
    @@ -247,7 +247,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:69
  • error: ((args) => void)
    @@ -269,7 +269,7 @@
    args: Returns void
    +
  • Defined in classes/queue-events.ts:76
  • failed: ((args, id) => void)
    @@ -300,7 +300,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:83
  • ioredis:close: (() => void)
    @@ -318,7 +318,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: ((args, id) => void)
    @@ -343,7 +343,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:93
  • progress: ((args, id) => void)
    @@ -375,7 +375,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:103
  • removed: ((args, id) => void)
    @@ -405,7 +405,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:114
  • resumed: ((args, id) => void)
    @@ -430,7 +430,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:121
  • retries-exhausted: ((args, id) => void)
    @@ -459,7 +459,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:128
  • stalled: ((args, id) => void)
    @@ -488,7 +488,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:140
  • waiting: ((args, id) => void)
    @@ -517,7 +517,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:147
  • 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:17
  • lastEventId?: string
    @@ -88,7 +88,7 @@
    +
  • Defined in interfaces/queue-options.ts:79
  • prefix?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in interfaces/queue-options.ts:32
  • sharedConnection?: boolean
    @@ -106,7 +106,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • +
  • Defined in classes/queue.ts:44
  • ioredis:close: (() => void)
    @@ -114,7 +114,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: (() => void)
    @@ -131,7 +131,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/queue.ts:51
  • progress: ((job, progress) => void)
    @@ -155,7 +155,7 @@
    progress: Returns void
    +
  • Defined in classes/queue.ts:58
  • removed: ((job) => void)
    @@ -177,7 +177,7 @@
    job: Returns void
    +
  • Defined in classes/queue.ts:68
  • resumed: (() => void)
    @@ -194,7 +194,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/queue.ts:75
  • waiting: ((job) => void)
    @@ -216,7 +216,7 @@
    job: Returns void
    +
  • Defined in classes/queue.ts:82
  • +
  • Defined in interfaces/queue-options.ts:17
  • defaultJobOptions?: DefaultJobOptions
    +
  • Defined in interfaces/queue-options.ts:39
  • prefix?: string
    @@ -76,12 +76,12 @@
    +
  • Defined in interfaces/queue-options.ts:32
  • +
  • Defined in interfaces/queue-options.ts:56
  • sharedConnection?: boolean
    @@ -90,7 +90,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • streams?: {
        events: {
            maxLen: number;
        };
    }
    @@ -112,7 +112,7 @@
    maxLen
    +
  • Defined in interfaces/queue-options.ts:44
  • +
  • Defined in interfaces/rate-limiter-options.ts:6
  • +
  • Defined in interfaces/queue-options.ts:17
  • prefix?: string
    @@ -69,12 +69,12 @@
    +
  • Defined in interfaces/queue-options.ts:32
  • +
  • Defined in interfaces/queue-options.ts:63
  • sharedConnection?: boolean
    @@ -83,7 +83,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • Returns void

    +
  • Defined in interfaces/sandboxed-job.ts:12
  • name: string
    +
  • Defined in interfaces/job-json.ts:6
  • +
  • Defined in interfaces/sandboxed-job.ts:10
  • parent?: ParentKeys
    +
  • Defined in interfaces/job-json.ts:17
  • parentKey?: string
    +
  • Defined in interfaces/job-json.ts:18
  • processedOn?: number
    +
  • Defined in interfaces/job-json.ts:12
  • repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19
  • returnValue: R
    +
  • Defined in interfaces/sandboxed-job.ts:14
  • returnvalue: string
    +
  • Defined in interfaces/job-json.ts:16
  • stacktrace: string
    +
  • Defined in interfaces/job-json.ts:15
  • timestamp: number
    +
  • Defined in interfaces/job-json.ts:13
  • updateData: ((data) => Promise<void>)
    @@ -185,7 +185,7 @@

    Parameters

    data: any

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:13
  • 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:30
  • numberOfKeys?: number
    +
  • Defined in commands/script-loader.ts:32
  • path: string
    @@ -79,7 +79,7 @@
    +
  • Defined in commands/script-loader.ts:37
  • token: string
    @@ -87,7 +87,7 @@
    +
  • Defined in commands/script-loader.ts:45
  • +
  • Defined in classes/worker.ts:55
  • closing: ((msg) => void)
    @@ -118,7 +118,7 @@
    msg: Returns void
    +
  • Defined in classes/worker.ts:62
  • completed: ((job, result, prev) => void)
    @@ -144,7 +144,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:69
  • drained: (() => void)
    @@ -163,7 +163,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:82
  • error: ((failedReason) => void)
    @@ -185,7 +185,7 @@
    failedReason: Returns void
    +
  • Defined in classes/worker.ts:89
  • failed: ((job, error, prev) => void)
    @@ -213,7 +213,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:98
  • ioredis:close: (() => void)
    @@ -231,7 +231,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • paused: (() => void)
    @@ -248,7 +248,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:109
  • progress: ((job, progress) => void)
    @@ -275,7 +275,7 @@
    progress: Returns void
    +
  • Defined in classes/worker.ts:119
  • ready: (() => void)
    @@ -292,7 +292,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:129
  • resumed: (() => void)
    @@ -309,7 +309,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:136
  • stalled: ((jobId, prev) => void)
    @@ -334,7 +334,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:144
  • +
  • Defined in interfaces/queue-options.ts:27
  • concurrency?: number
    @@ -91,7 +91,7 @@

    Default

    1
     

    See

    https://docs.bullmq.io/guide/workers/concurrency

    +
  • Defined in interfaces/worker-options.ts:31
  • connection?: ConnectionOptions
    @@ -100,7 +100,7 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • drainDelay?: number
    @@ -111,7 +111,7 @@

    Default

    5
     
    +
  • Defined in interfaces/worker-options.ts:99
  • @@ -121,7 +121,7 @@

    https://docs.bullmq.io/guide/rate-limiting

    +
  • Defined in interfaces/worker-options.ts:37
  • lockDuration?: number
    @@ -135,7 +135,7 @@

    Default

    30000
     
    +
  • Defined in interfaces/worker-options.ts:110
  • lockRenewTime?: number
    @@ -145,7 +145,7 @@
    +
  • Defined in interfaces/worker-options.ts:118
  • maxStalledCount?: number
    @@ -158,7 +158,7 @@

    Default

    1
     
    +
  • Defined in interfaces/worker-options.ts:52
  • metrics?: MetricsOptions
    @@ -168,7 +168,7 @@

    https://docs.bullmq.io/guide/metrics

    +
  • Defined in interfaces/worker-options.ts:43
  • prefix?: string
    @@ -177,7 +177,7 @@
    +
  • Defined in interfaces/queue-options.ts:32
  • removeOnComplete?: KeepJobs
    @@ -187,7 +187,7 @@
    +
  • Defined in interfaces/worker-options.ts:66
  • removeOnFail?: KeepJobs
    @@ -197,7 +197,7 @@
    +
  • Defined in interfaces/worker-options.ts:73
  • runRetryDelay?: number
    @@ -208,7 +208,7 @@

    Default

    15000
     
    +
  • Defined in interfaces/worker-options.ts:125
  • settings?: AdvancedOptions
    @@ -216,7 +216,7 @@
    +
  • Defined in interfaces/worker-options.ts:130
  • sharedConnection?: boolean
    @@ -225,7 +225,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • skipLockRenewal?: boolean
    @@ -238,7 +238,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:91
  • skipStalledCheck?: boolean
    @@ -251,7 +251,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:82
  • stalledInterval?: number
    @@ -262,7 +262,7 @@

    Default

    30000
     
    +
  • Defined in interfaces/worker-options.ts:59
  • useWorkerThreads?: boolean
    @@ -275,7 +275,7 @@

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:139
  • +
  • Defined in types/backoff-strategy.ts:3
  • +
  • Defined in interfaces/minimal-job.ts:5
  • +
  • Defined in interfaces/redis-options.ts:9
  • +
  • Defined in interfaces/redis-options.ts:11
  • +
  • Defined in interfaces/redis-streams.ts:6
  • +
  • Defined in interfaces/redis-streams.ts:7
  • +
  • Defined in types/finished-status.ts:3
  • +
  • Defined in types/finished-status.ts:1
  • +
  • Defined in interfaces/flow-job.ts:13
  • +
  • Defined in interfaces/flow-job.ts:15
  • +
  • Defined in interfaces/flow-job.ts:17
  • +
  • Defined in classes/scripts.ts:38
  • +
  • Defined in types/job-json-sandbox.ts:3
  • +
  • Defined in types/job-type.ts:3
  • +
  • Defined in types/job-type.ts:11
  • +
  • Defined in types/job-options.ts:3
  • +
  • Defined in classes/queue-keys.ts:1
  • +
  • Defined in types/minimal-queue.ts:3
  • +
  • Defined in interfaces/parent.ts:18
  • +
  • Defined in interfaces/worker-options.ts:11
  • +
  • Defined in interfaces/connection.ts:4
  • +
  • Defined in types/job-options.ts:13
  • +
  • Defined in interfaces/redis-options.ts:7
  • +
  • Defined in types/repeat-strategy.ts:3
  • +
  • Defined in interfaces/sandboxed-job-processor.ts:6
  • +
  • Defined in interfaces/redis-streams.ts:5
  • +
  • Defined in interfaces/redis-streams.ts:8
  • +
  • Defined in utils.ts:112
  • +
  • Defined in utils.ts:110
  • +
  • Defined in utils.ts:185
  • +
  • Defined in utils.ts:183
  • +
  • Defined in utils.ts:107
  • +
  • Defined in utils.ts:8
  • +
  • Defined in commands/index.ts:4