diff --git a/classes/v1.Backoffs.html b/classes/v1.Backoffs.html index 4eac6a2bfd..6e66c52a04 100644 --- a/classes/v1.Backoffs.html +++ b/classes/v1.Backoffs.html @@ -1,4 +1,4 @@ -Backoffs | bullmq - v4.15.3
+Backoffs | bullmq - v4.15.4
  • Preparing search index...
  • -
  • The search index is not available
bullmq - v4.15.3
+
  • The search index is not available
  • bullmq - v4.15.4
    @@ -112,7 +112,7 @@

    calculate
  • normalize
  • @@ -195,7 +195,7 @@

    remove
  • retain
  • @@ -144,7 +144,7 @@

    stop
  • waitForCurrentJobAndExit
  • @@ -343,7 +343,7 @@

    on
  • once
  • @@ -996,7 +996,7 @@

    fromId
  • fromJSON
  • @@ -1225,7 +1225,7 @@

    trimEvents
  • waitUntilReady
  • @@ -1165,7 +1165,7 @@

    retryJob
  • setWorkerName
  • @@ -246,7 +246,7 @@

    emit
  • waitUntilReady
  • @@ -330,7 +330,7 @@

    run
  • waitUntilReady
  • @@ -750,7 +750,7 @@

    getWorkers
  • waitUntilReady
  • @@ -128,7 +128,7 @@

    getPrefixedQueueName
  • toKey
  • @@ -355,7 +355,7 @@

    run
  • waitUntilReady
  • @@ -161,7 +161,7 @@

    reconnect
  • waitUntilReady
  • @@ -333,7 +333,7 @@

    removeRepeatableByKey
  • waitUntilReady
  • @@ -262,7 +262,7 @@

    parseScript
  • resolvePath
  • @@ -111,7 +111,7 @@

    path
  • position
  • @@ -653,7 +653,7 @@

    updateDelaySet
  • updateProgress
  • @@ -123,7 +123,7 @@

    clearTimer
  • setTimer
  • @@ -73,7 +73,7 @@

    constructor

    @@ -507,7 +507,7 @@

    run
  • waitUntilReady
  • @@ -112,7 +112,7 @@

    calculate
  • normalize
  • @@ -195,7 +195,7 @@

    remove
  • retain
  • @@ -144,7 +144,7 @@

    stop
  • waitForCurrentJobAndExit
  • @@ -343,7 +343,7 @@

    on
  • once
  • @@ -1012,7 +1012,7 @@

    fromId
  • fromJSON
  • @@ -1225,7 +1225,7 @@

    trimEvents
  • waitUntilReady
  • @@ -245,7 +245,7 @@

    emit
  • waitUntilReady
  • @@ -330,7 +330,7 @@

    run
  • waitUntilReady
  • @@ -750,7 +750,7 @@

    getWorkers
  • waitUntilReady
  • @@ -128,7 +128,7 @@

    getPrefixedQueueName
  • toKey
  • @@ -175,7 +175,7 @@

    reconnect
  • waitUntilReady
  • @@ -333,7 +333,7 @@

    removeRepeatableByKey
  • waitUntilReady
  • @@ -262,7 +262,7 @@

    parseScript
  • resolvePath
  • @@ -111,7 +111,7 @@

    path
  • position
  • @@ -634,7 +634,7 @@

    updateData
  • updateProgress
  • @@ -123,7 +123,7 @@

    clearTimer
  • setTimer
  • @@ -73,7 +73,7 @@

    constructor

    @@ -514,7 +514,7 @@

    run
  • waitUntilReady
  • @@ -155,7 +155,7 @@

    numTotal
  • waitAll
  • @@ -112,7 +112,7 @@

    calculate
  • normalize
  • @@ -195,7 +195,7 @@

    remove
  • retain
  • @@ -162,7 +162,7 @@

    stop
  • waitForCurrentJobAndExit
  • @@ -73,7 +73,7 @@

    constructor

    @@ -343,7 +343,7 @@

    on
  • once
  • @@ -1095,7 +1095,7 @@

    fromId
  • fromJSON
  • @@ -1219,7 +1219,7 @@

    trimEvents
  • waitUntilReady
  • @@ -258,7 +258,7 @@

    emit
  • waitUntilReady
  • @@ -330,7 +330,7 @@

    run
  • waitUntilReady
  • @@ -756,7 +756,7 @@

    getWorkers
  • waitUntilReady
  • @@ -128,7 +128,7 @@

    getPrefixedQueueName
  • toKey
  • @@ -175,7 +175,7 @@

    reconnect
  • waitUntilReady
  • @@ -333,7 +333,7 @@

    removeRepeatableByKey
  • waitUntilReady
  • @@ -262,7 +262,7 @@

    parseScript
  • resolvePath
  • @@ -104,7 +104,7 @@

    line
  • position
  • @@ -764,7 +764,7 @@

    updateData
  • updateProgress
  • @@ -73,7 +73,7 @@

    constructor

    @@ -73,7 +73,7 @@

    constructor

    @@ -573,7 +573,7 @@

    waitUntilReady
  • RateLimitError
  • @@ -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:34
  • Methods

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

    Parameters

    promise: Promise<T>

    Returns void

    +
  • Defined in classes/async-fifo-queue.ts:38
  • +
  • Defined in classes/async-fifo-queue.ts:97
  • +
  • Defined in classes/async-fifo-queue.ts:68
  • +
  • Defined in classes/async-fifo-queue.ts:72
  • +
  • Defined in classes/async-fifo-queue.ts:64
  • +
  • Defined in classes/async-fifo-queue.ts:60
  • @@ -21,7 +21,7 @@

    Hierarchy

    +
  • Defined in classes/backoffs.ts:8
  • @@ -54,7 +54,7 @@

    Properties

    builtinStrategies: BuiltInStrategies = ...
    +
  • Defined in classes/backoffs.ts:9
  • Methods

    @@ -77,7 +77,7 @@
    job: Optional customStrategy: BackoffStrategy

    Returns number | Promise<number>

    +
  • Defined in classes/backoffs.ts:36
  • Returns BackoffOptions

    +
  • Defined in classes/backoffs.ts:23
  • @@ -21,7 +21,7 @@

    Hierarchy

    +
  • Defined in classes/child-pool.ts:11
  • @@ -60,7 +60,7 @@

    Parameters

    __namedParameters: ChildPoolOpts

    Returns ChildPool

    +
  • Defined in classes/child-pool.ts:16
  • Properties

    @@ -72,7 +72,7 @@

    Type declaration

  • [key: string]: Child[]
  • +
  • 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
  • @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in classes/child-processor.ts:19
  • @@ -75,24 +75,24 @@
    msg: Returns Promise<void>

    Returns ChildProcessor

    +
  • Defined in classes/child-processor.ts:24
  • Properties

    currentJobPromise: Promise<unknown>
    +
  • Defined in classes/child-processor.ts:22
  • processor: any
    +
  • Defined in classes/child-processor.ts:21
  • status?: ChildStatus
    +
  • Defined in classes/child-processor.ts:20
  • Methods

    @@ -107,7 +107,7 @@

    Parameters

    processorFile: string

    Returns Promise<void>

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

    +
  • Defined in classes/child-processor.ts:64
  • +
  • Defined in classes/child-processor.ts:92
  • +
  • Defined in classes/child-processor.ts:94
  • @@ -29,7 +29,7 @@

    Hierarchy

    +
  • Defined in classes/errors/delayed-error.ts:8
  • @@ -54,7 +54,7 @@
    Optional Returns DelayedError
    +
  • Defined in classes/errors/delayed-error.ts:9
  • @@ -32,7 +32,7 @@

    Hierarchy

    +
  • Defined in classes/flow-producer.ts:92
  • @@ -84,29 +84,29 @@
    Connection: Returns FlowProducer
    +
  • Defined in classes/flow-producer.ts:100
  • Properties

    closing: Promise<void>
    +
  • Defined in classes/flow-producer.ts:95
  • keys: KeysMap
    +
  • Defined in classes/flow-producer.ts:94
  • opts: QueueBaseOptions = {}
    +
  • Defined in classes/flow-producer.ts:101
  • queueKeys: QueueKeys
    +
  • Defined in classes/flow-producer.ts:96
  • toKey: ((name, type) => string)
    @@ -126,7 +126,7 @@
    name: type: string

    Returns string

    +
  • Defined in classes/flow-producer.ts:93
  • Accessors

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

    @@ -168,7 +168,7 @@
    Optional Returns Promise<JobNode>
    +
  • Defined in classes/flow-producer.ts:197
  • +
  • Defined in classes/flow-producer.ts:262
  • +
  • Defined in classes/flow-producer.ts:477
  • +
  • Defined in classes/flow-producer.ts:488
  • +
  • Defined in classes/flow-producer.ts:138
  • +
  • Defined in classes/flow-producer.ts:230
  • +
  • Defined in classes/flow-producer.ts:145
  • +
  • Defined in classes/flow-producer.ts:153
  • +
  • Defined in classes/flow-producer.ts:161
  • +
  • Defined in classes/flow-producer.ts:183
  • @@ -41,7 +41,7 @@

    Implements

    +
  • Defined in classes/job.ts:60
  • @@ -155,7 +155,7 @@
    opts: Optional id: string

    Returns Job<DataType, ReturnType, NameType>

    +
  • Defined in classes/job.ts:148
  • Properties

    @@ -169,7 +169,7 @@

    Default Value

    0
     
    +
  • Defined in classes/job.ts:105
  • data: DataType
    @@ -178,7 +178,7 @@
    +
  • Defined in classes/job.ts:158
  • delay: number
    @@ -190,7 +190,7 @@

    Default Value

    0
     
    +
  • Defined in classes/job.ts:94
  • failedReason: string
    @@ -199,7 +199,7 @@
    +
  • Defined in classes/job.ts:110
  • finishedOn?: number
    @@ -208,13 +208,13 @@
    +
  • Defined in classes/job.ts:115
  • id?: string
    +
  • Defined in classes/job.ts:164
  • name: NameType
    @@ -223,7 +223,7 @@
    +
  • Defined in classes/job.ts:153
  • opts: JobsOptions = {}
    @@ -232,7 +232,7 @@
    +
  • Defined in classes/job.ts:163
  • parent?: ParentKeys
    @@ -241,7 +241,7 @@
    +
  • Defined in classes/job.ts:130
  • parentKey?: string
    @@ -250,7 +250,7 @@
    +
  • Defined in classes/job.ts:125
  • processedOn?: number
    @@ -259,7 +259,7 @@
    +
  • Defined in classes/job.ts:120
  • progress: number | object = 0
    @@ -271,7 +271,7 @@

    Default Value

    0
     
    +
  • Defined in classes/job.ts:76
  • queueQualifiedName: string
    @@ -282,7 +282,7 @@

    See

    Implementation of MinimalJob.queueQualifiedName

    +
  • Defined in classes/job.ts:70
  • repeatJobKey?: string
    @@ -291,7 +291,7 @@
    +
  • Defined in classes/job.ts:135
  • returnvalue: ReturnType = null
    @@ -303,7 +303,7 @@

    Default Value

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

    Default Value

    null
    +
  • Defined in classes/job.ts:88
  • timestamp: number
    @@ -324,7 +324,7 @@
    +
  • Defined in classes/job.ts:99
  • token?: string
    @@ -332,7 +332,7 @@
    +
  • Defined in classes/job.ts:140
  • Accessors

    @@ -345,7 +345,7 @@

    Returns string

    +
  • Defined in classes/job.ts:748
    • @@ -356,7 +356,7 @@

      Returns string

    +
  • Defined in classes/job.ts:741
  • Methods

    @@ -376,7 +376,7 @@
    Optional Returns Promise<string>
    +
  • Defined in classes/job.ts:1105
  • +
  • Defined in classes/job.ts:423
  • +
  • Defined in classes/job.ts:465
  • +
  • Defined in classes/job.ts:768
  • +
  • Defined in classes/job.ts:778
  • +
  • Defined in classes/job.ts:510
  • +
  • Defined in classes/job.ts:1083
  • +
  • Defined in classes/job.ts:550
  • +
  • Defined in classes/job.ts:790
  • +
  • Defined in classes/job.ts:812
  • +
  • Defined in classes/job.ts:904
  • +
  • Defined in classes/job.ts:758
  • +
  • Defined in classes/job.ts:727
  • +
  • Defined in classes/job.ts:699
  • +
  • Defined in classes/job.ts:713
  • +
  • Defined in classes/job.ts:706
  • +
  • Defined in classes/job.ts:734
  • +
  • Defined in classes/job.ts:720
  • +
  • Defined in classes/job.ts:501
  • +
  • Defined in classes/job.ts:563
  • +
  • Defined in classes/job.ts:1028
  • +
  • Defined in classes/job.ts:601
  • +
  • Defined in classes/job.ts:1045
  • +
  • Defined in classes/job.ts:1055
  • +
  • Defined in classes/job.ts:528
  • +
  • Defined in classes/job.ts:1071
    • @@ -833,7 +833,7 @@
    +
  • Defined in classes/job.ts:414
  • +
  • Defined in classes/job.ts:478
  • +
  • Defined in classes/job.ts:489
  • +
  • Defined in classes/job.ts:956
  • +
  • Defined in classes/job.ts:389
  • +
  • Defined in classes/job.ts:205
  • +
  • Defined in classes/job.ts:232
  • +
  • Defined in classes/job.ts:361
  • +
  • Defined in classes/job.ts:279
  • @@ -38,7 +38,7 @@

    Hierarchy

    • Queue
    +
  • Defined in classes/queue.ts:92
  • @@ -148,7 +148,7 @@
    Optional Returns Queue<DataType, ResultType, NameType>
    +
  • Defined in classes/queue.ts:101
  • Properties

    @@ -156,18 +156,18 @@
    +
  • Defined in classes/queue-base.ts:26
  • jobsOpts: BaseJobOptions
    +
  • Defined in classes/queue.ts:98
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -176,7 +176,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -185,13 +185,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -210,12 +210,12 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • token: string = ...
    +
  • Defined in classes/queue.ts:97
  • Accessors

    @@ -229,7 +229,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue.ts:167
  • +
  • Defined in classes/queue-base.ts:97
  • +
  • Defined in classes/queue.ts:171
  • Methods

    @@ -291,7 +291,7 @@
    Optional Returns Promise<Job<DataType, ResultType, NameType>>
    +
  • Defined in classes/queue.ts:191
  • +
  • Defined in classes/queue.ts:231
  • +
  • Defined in classes/queue.ts:388
  • +
  • Defined in classes/queue.ts:417
  • +
  • Defined in classes/queue.ts:268
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue.ts:403
  • +
  • Defined in classes/queue.ts:133
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:186
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:165
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:179
  • +
  • Defined in classes/queue-getters.ts:289
  • +
  • Defined in classes/queue-getters.ts:172
  • +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:127
  • +
  • Defined in classes/queue-getters.ts:137
  • +
  • Defined in classes/queue-getters.ts:366
  • +
  • Defined in classes/queue-getters.ts:158
  • +
  • Defined in classes/queue-getters.ts:339
  • +
  • Defined in classes/queue-getters.ts:454
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:193
  • +
  • Defined in classes/queue-getters.ts:432
  • +
  • Defined in classes/queue-getters.ts:296
  • +
  • Defined in classes/queue-getters.ts:114
  • +
  • Defined in classes/queue.ts:304
  • +
  • Defined in classes/queue-getters.ts:216
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:207
  • +
  • Defined in classes/queue-getters.ts:200
  • +
  • Defined in classes/queue-getters.ts:418
  • +
  • Defined in classes/queue.ts:290
  • +
  • Defined in classes/queue.ts:464
  • +
  • Defined in classes/queue.ts:140
  • +
  • Defined in classes/queue.ts:148
  • +
  • Defined in classes/queue.ts:156
  • +
  • Defined in classes/queue.ts:259
  • +
  • Defined in classes/queue.ts:508
  • +
  • Defined in classes/queue.ts:362
    • @@ -1170,7 +1170,7 @@
    +
  • Defined in classes/queue.ts:528
  • +
  • Defined in classes/queue.ts:325
  • +
  • Defined in classes/queue.ts:346
  • +
  • Defined in classes/queue.ts:282
  • +
  • Defined in classes/queue.ts:487
  • +
  • Defined in classes/queue.ts:520
  • +
  • Defined in classes/queue.ts:372
  • +
  • Defined in classes/queue-base.ts:129
  • @@ -37,7 +37,7 @@

    Implements

    +
  • Defined in classes/queue-base.ts:23
  • @@ -97,7 +97,7 @@
    Connection: Returns QueueBase
    +
  • Defined in classes/queue-base.ts:40
  • Properties

    @@ -105,13 +105,13 @@
    +
  • Defined in classes/queue-base.ts:26
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -120,7 +120,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -129,13 +129,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -154,7 +154,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -168,7 +168,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

    @@ -193,7 +193,7 @@
    +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-base.ts:158
    • @@ -227,7 +227,7 @@

      Returns booleanImplementation of MinimalQueue.emit

      Overrides EventEmitter.emit

    +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/queue-base.ts:129
  • @@ -29,7 +29,7 @@

    Hierarchy

    • QueueEvents
    +
  • Defined in classes/queue-events.ts:164
  • @@ -83,7 +83,7 @@
    Optional Returns QueueEvents
    +
  • Defined in classes/queue-events.ts:167
  • Properties

    @@ -91,13 +91,13 @@
    +
  • Defined in classes/queue-base.ts:26
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -106,7 +106,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -154,7 +154,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

    @@ -180,7 +180,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-events.ts:304
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • 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:129
  • @@ -38,7 +38,7 @@

    Hierarchy

    +
  • Defined in classes/queue-getters.ts:21
  • @@ -133,7 +133,7 @@
    Connection: Returns QueueGetters<DataType, ResultType, NameType>
    +
  • Defined in classes/queue-base.ts:40
  • Properties

    @@ -141,13 +141,13 @@
    +
  • Defined in classes/queue-base.ts:26
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -156,7 +156,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -165,13 +165,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -190,7 +190,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -204,7 +204,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

    @@ -230,7 +230,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-getters.ts:96
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/queue-getters.ts:241
  • +
  • Defined in classes/queue-getters.ts:186
  • +
  • Defined in classes/queue-getters.ts:277
  • +
  • Defined in classes/queue-getters.ts:165
  • +
  • Defined in classes/queue-getters.ts:253
  • +
  • Defined in classes/queue-getters.ts:179
  • +
  • Defined in classes/queue-getters.ts:289
  • +
  • Defined in classes/queue-getters.ts:172
    • @@ -429,7 +429,7 @@

      Parameters

      jobId: string

    Returns Promise<Job<DataType, ResultType, NameType>>

    +
  • Defined in classes/queue-getters.ts:26
  • +
  • Defined in classes/queue-getters.ts:127
  • +
  • Defined in classes/queue-getters.ts:137
    • @@ -500,7 +500,7 @@
      asc: Returns Promise<{
          count: number;
          logs: string[];
      }>
    +
  • Defined in classes/queue-getters.ts:366
  • +
  • Defined in classes/queue-getters.ts:158
  • +
  • Defined in classes/queue-getters.ts:339
  • +
  • Defined in classes/queue-getters.ts:454
  • +
  • Defined in classes/queue-getters.ts:265
  • +
  • Defined in classes/queue-getters.ts:193
  • +
  • Defined in classes/queue-getters.ts:432
    • @@ -655,7 +655,7 @@
      end: asc: boolean = false

    Returns Promise<string[]>

    +
  • Defined in classes/queue-getters.ts:296
  • +
  • Defined in classes/queue-getters.ts:114
  • +
  • Defined in classes/queue-getters.ts:216
  • +
  • Defined in classes/queue-getters.ts:229
  • +
  • Defined in classes/queue-getters.ts:207
  • +
  • Defined in classes/queue-getters.ts:200
  • +
  • Defined in classes/queue-getters.ts:418
  • +
  • Defined in classes/queue-base.ts:129
  • @@ -21,7 +21,7 @@

    Hierarchy

    • QueueKeys
    +
  • Defined in classes/queue-keys.ts:3
  • @@ -55,14 +55,14 @@

    Parameters

    prefix: string = 'bull'

    Returns QueueKeys

    +
  • Defined in classes/queue-keys.ts:4
  • Properties

    prefix: string = 'bull'
    +
  • Defined in classes/queue-keys.ts:4
  • Methods

    @@ -77,7 +77,7 @@

    Parameters

    name: string

    Returns KeysMap

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

      Parameters

      name: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:37
    • @@ -105,7 +105,7 @@
      name: type: string

    Returns string

    +
  • Defined in classes/queue-keys.ts:33
  • @@ -28,7 +28,7 @@

    Hierarchy

    • RateLimitError
    +
  • Defined in classes/errors/rate-limit-error.ts:9
  • @@ -53,7 +53,7 @@
    message: Returns RateLimitError
    +
  • Defined in classes/errors/rate-limit-error.ts:10
  • @@ -23,7 +23,7 @@

    Hierarchy

    • RedisConnection
    +
  • Defined in classes/redis-connection.ts:37
  • @@ -73,29 +73,29 @@
    skipVersionCheck: Returns RedisConnection
    +
  • Defined in classes/redis-connection.ts:57
  • Properties

    capabilities: RedisCapabilities = ...
    +
  • Defined in classes/redis-connection.ts:42
  • closing: boolean
    +
  • Defined in classes/redis-connection.ts:41
  • minimumVersion: string = '5.0.0'
    +
  • Defined in classes/redis-connection.ts:38
  • recommendedMinimumVersion: string = '6.2.0'
    +
  • Defined in classes/redis-connection.ts:39
  • Accessors

    @@ -105,7 +105,7 @@
    +
  • Defined in classes/redis-connection.ts:175
  • +
  • Defined in classes/redis-connection.ts:324
  • Methods

    @@ -123,7 +123,7 @@
    +
  • Defined in classes/redis-connection.ts:275
    • @@ -136,7 +136,7 @@

      Parameters

      wait: boolean = true

    Returns Promise<void>

    +
  • Defined in classes/redis-connection.ts:239
  • +
  • Defined in classes/redis-connection.ts:270
  • +
  • Defined in classes/redis-connection.ts:128
  • @@ -28,7 +28,7 @@

    Hierarchy

    • Repeat
    +
  • Defined in classes/repeat.ts:9
  • @@ -83,7 +83,7 @@
    Optional Returns Repeat
    +
  • Defined in classes/repeat.ts:13
  • Properties

    @@ -91,13 +91,13 @@
    +
  • Defined in classes/queue-base.ts:26
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -106,7 +106,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • opts: QueueBaseOptions = {}
    @@ -115,13 +115,13 @@
    +
  • Defined in classes/queue-base.ts:42
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -140,7 +140,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -154,7 +154,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
  • +
  • Defined in classes/queue-base.ts:97
  • Methods

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

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

    +
  • Defined in classes/repeat.ts:27
  • +
  • Defined in classes/queue-base.ts:146
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/queue-base.ts:115
  • +
  • Defined in classes/repeat.ts:206
    • @@ -267,7 +267,7 @@
      end: asc: boolean = false

    Returns Promise<RepeatableJob[]>

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

    +
  • Defined in classes/repeat.ts:143
    • @@ -297,7 +297,7 @@

      Parameters

      repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/repeat.ts:159
  • +
  • Defined in classes/queue-base.ts:129
  • @@ -25,7 +25,7 @@

    Hierarchy

    • ScriptLoader
    +
  • Defined in commands/script-loader.ts:84
  • @@ -55,7 +55,7 @@
    +
  • Defined in commands/script-loader.ts:96
  • Methods

    @@ -83,7 +83,7 @@
    mappedPath: Returns void
    +
  • Defined in commands/script-loader.ts:110
  • +
  • Defined in commands/script-loader.ts:463
  • +
  • Defined in commands/script-loader.ts:333
  • +
  • Defined in commands/script-loader.ts:435
    • @@ -159,7 +159,7 @@
      filename: Optional cache: Map<string, ScriptMetadata>

    Returns Promise<Command>

    +
  • Defined in commands/script-loader.ts:356
  • +
  • Defined in commands/script-loader.ts:390
  • +
  • Defined in commands/script-loader.ts:305
  • +
  • Defined in commands/script-loader.ts:134
  • @@ -23,7 +23,7 @@

    Hierarchy

    • ScriptLoaderError
    +
  • Defined in commands/script-loader.ts:52
  • @@ -62,7 +62,7 @@
    position: Returns ScriptLoaderError
    +
  • Defined in commands/script-loader.ts:60
  • Properties

    @@ -72,17 +72,17 @@
    +
  • Defined in commands/script-loader.ts:56
  • line: number
    +
  • Defined in commands/script-loader.ts:57
  • position: number
    +
  • Defined in commands/script-loader.ts:58
  • @@ -21,7 +21,7 @@

    Hierarchy

    • Scripts
    +
  • Defined in classes/scripts.ts:40
  • @@ -86,14 +86,14 @@

    Parameters

    queue: MinimalQueue

    Returns Scripts

    +
  • Defined in classes/scripts.ts:43
  • Properties

    moveToFinishedKeys: string[]
    +
  • Defined in classes/scripts.ts:41
  • Methods

    @@ -116,7 +116,7 @@
    jobId: parentOpts: ParentOpts = {}

    Returns Promise<string>

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

    Returns Promise<void>

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

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:609
  • +
  • Defined in classes/scripts.ts:778
    • @@ -182,7 +182,7 @@

      Parameters

      delayed: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:443
    • @@ -201,7 +201,7 @@
      duration: Optional client: ChainableCommander | RedisClient

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:263
    • @@ -220,7 +220,7 @@
      command: Optional state: string

    Returns Error

    +
  • Defined in classes/scripts.ts:400
    • @@ -233,7 +233,7 @@

      Parameters

      types: JobType[]

    Returns Promise<number[]>

    +
  • Defined in classes/scripts.ts:493
    • @@ -252,7 +252,7 @@
      end: asc: boolean = false

    Returns Promise<[string][]>

    +
  • Defined in classes/scripts.ts:468
    • @@ -265,7 +265,7 @@

      Parameters

      jobId: string

    Returns Promise<"unknown" | JobState>

    +
  • Defined in classes/scripts.ts:555
    • @@ -280,7 +280,7 @@
      jobId: returnValue: boolean = false

    Returns Promise<number | [number, string]>

    +
  • Defined in classes/scripts.ts:540
    • @@ -295,7 +295,7 @@
      listKey: jobId: string

    Returns Promise<boolean>

    +
  • Defined in classes/scripts.ts:63
  • +
  • Defined in classes/scripts.ts:1009
    • @@ -334,7 +334,7 @@
    +
  • Defined in classes/scripts.ts:977
    • @@ -351,7 +351,7 @@
      token: Optional jobId: string

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:912
    • @@ -381,7 +381,7 @@
      token: fetchNext: boolean = false

    Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:500
    • @@ -400,7 +400,7 @@
      delay: token: string = '0'

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:722
    • @@ -419,7 +419,7 @@
      token: delay: number

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:645
    • @@ -449,7 +449,7 @@
      token: fetchNext: boolean = false

    Returns (string | number | boolean | Buffer)[]

    +
  • Defined in classes/scripts.ts:520
    • @@ -464,7 +464,7 @@
      jobId: args: (string | number | boolean | Buffer)[]

    Returns Promise<any[]>

    +
  • Defined in classes/scripts.ts:384
    • @@ -494,7 +494,7 @@

      Throws

      JobNotInState This exception is thrown if job is not in active state.

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

    +
  • Defined in classes/scripts.ts:699
    • @@ -529,7 +529,7 @@
      countforce: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:1032
    • @@ -542,7 +542,7 @@

      Parameters

      pause: boolean

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:212
    • @@ -555,7 +555,7 @@

      Parameters

      jobId: string

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:947
    • @@ -568,7 +568,7 @@

      Parameters

      count: number = 1000

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:859
    • @@ -583,7 +583,7 @@
      jobId: removeChildren: boolean

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:254
    • @@ -598,7 +598,7 @@
      repeatJobId: repeatJobKey: string

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:244
  • +
  • Defined in classes/scripts.ts:880
    • @@ -651,7 +651,7 @@
      lifo: token: string

    Returns (string | number)[]

    +
  • Defined in classes/scripts.ts:795
    • @@ -668,7 +668,7 @@
      count: timestamp: number = ...

    Returns Promise<number>

    +
  • Defined in classes/scripts.ts:847
    • @@ -685,7 +685,7 @@
      stacktrace: failedReason: string

    Returns string[]

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

    +
  • Defined in classes/scripts.ts:280
    • @@ -733,7 +733,7 @@
      jobId: progress: number | object

    Returns Promise<void>

    +
  • Defined in classes/scripts.ts:296
  • @@ -29,7 +29,7 @@

    Hierarchy

    • UnrecoverableError
    +
  • Defined in classes/errors/unrecoverable-error.ts:8
  • @@ -54,7 +54,7 @@
    Optional Returns UnrecoverableError
    +
  • Defined in classes/errors/unrecoverable-error.ts:9
  • @@ -29,7 +29,7 @@

    Hierarchy

    • WaitingChildrenError
    +
  • Defined in classes/errors/waiting-children-error.ts:8
  • @@ -54,7 +54,7 @@
    Optional Returns WaitingChildrenError
    +
  • Defined in classes/errors/waiting-children-error.ts:9
  • @@ -38,7 +38,7 @@

    Hierarchy

    • Worker
    +
  • Defined in classes/worker.ts:161
  • @@ -116,7 +116,7 @@
    Optional Returns Worker<DataType, ResultType, NameType>
    +
  • Defined in classes/worker.ts:194
  • Properties

    @@ -124,18 +124,18 @@
    +
  • Defined in classes/queue-base.ts:26
  • id: string
    +
  • Defined in classes/worker.ts:167
  • keys: KeysMap
    +
  • Defined in classes/queue-base.ts:25
  • name: string
    @@ -144,7 +144,7 @@
    +
  • Defined in classes/queue-base.ts:41
  • @@ -153,13 +153,13 @@
    +
  • Defined in classes/worker.ts:166
  • qualifiedName: string
    +
  • Defined in classes/queue-base.ts:31
  • toKey: ((type) => string)
    @@ -178,7 +178,7 @@
    type: Returns string
    +
  • Defined in classes/queue-base.ts:24
  • Accessors

    @@ -192,7 +192,7 @@

    Returns Promise<

    +
  • Defined in classes/queue-base.ts:90
    • @@ -205,7 +205,7 @@

      Parameters

      concurrency: number

    Returns void

    +
  • Defined in classes/worker.ts:353
  • +
  • Defined in classes/queue-base.ts:97
  • +
  • Defined in classes/worker.ts:364
  • Methods

    @@ -250,7 +250,7 @@

    Returns Promise<

    +
  • Defined in classes/worker.ts:800
  • +
  • Defined in classes/worker.ts:638
  • +
  • Defined in classes/queue-base.ts:158
  • +
  • Defined in classes/worker.ts:293
  • +
  • Defined in classes/worker.ts:490
  • +
  • Defined in classes/worker.ts:775
  • +
  • Defined in classes/worker.ts:785
  • +
  • Defined in classes/worker.ts:300
  • +
  • Defined in classes/worker.ts:308
  • +
  • Defined in classes/worker.ts:316
  • +
  • Defined in classes/worker.ts:744
    • @@ -457,7 +457,7 @@

      Returns booleanjobsInProgress: Set<{
          job: Job<any, any, string>;
          ts: number;
      }>

    Returns Promise<void | Job<DataType, ResultType, NameType>>

    +
  • Defined in classes/worker.ts:672
  • +
  • Defined in classes/worker.ts:548
  • +
  • Defined in classes/worker.ts:762
  • +
  • Defined in classes/worker.ts:378
  • +
  • Defined in classes/worker.ts:851
  • +
  • Defined in classes/worker.ts:348
  • +
  • Defined in classes/worker.ts:190
  • @@ -66,7 +66,7 @@

    Start
  • Stop
  • @@ -59,7 +59,7 @@

    blocking
  • normal
  • @@ -80,7 +80,7 @@

    JobPendingDependencies
  • ParentJobNotExist
  • @@ -101,7 +101,7 @@

    THIRTY_MINUTES
  • TWO_WEEKS
  • @@ -101,7 +101,7 @@

    Progress
  • Update
  • @@ -66,7 +66,7 @@

    Start
  • Stop
  • @@ -59,7 +59,7 @@

    blocking
  • normal
  • @@ -80,7 +80,7 @@

    JobPendingDependencies
  • ParentJobNotExist
  • @@ -101,7 +101,7 @@

    THIRTY_MINUTES
  • TWO_WEEKS
  • @@ -101,7 +101,7 @@

    Progress
  • Update
  • @@ -66,7 +66,7 @@

    Start
  • Stop
  • @@ -59,7 +59,7 @@

    blocking
  • normal
  • @@ -87,7 +87,7 @@

    JobPendingDependencies
  • ParentJobNotExist
  • @@ -101,7 +101,7 @@

    THIRTY_MINUTES
  • TWO_WEEKS
  • @@ -101,7 +101,7 @@

    Progress
  • Update
  • @@ -17,7 +17,7 @@
  • ChildCommand
  • Enumeration ChildCommand

    +
  • Defined in enums/child-command.ts:1
  • @@ -35,17 +35,17 @@

    Enumeration Members

    Init: 0
    +
  • Defined in enums/child-command.ts:2
  • Start: 1
    +
  • Defined in enums/child-command.ts:3
  • Stop: 2
    +
  • Defined in enums/child-command.ts:4
  • @@ -17,7 +17,7 @@
  • ClientType
  • Enumeration ClientType

    +
  • Defined in interfaces/queue-options.ts:5
  • @@ -34,12 +34,12 @@

    Enumeration Members

    blocking: "blocking"
    +
  • Defined in interfaces/queue-options.ts:6
  • normal: "normal"
    +
  • Defined in interfaces/queue-options.ts:7
  • @@ -17,7 +17,7 @@
  • ErrorCode
  • Enumeration ErrorCode

    +
  • Defined in enums/error-code.ts:1
  • @@ -38,32 +38,32 @@

    Enumeration Members

    JobLockMismatch: -6
    +
  • Defined in enums/error-code.ts:7
  • JobLockNotExist: -2
    +
  • Defined in enums/error-code.ts:3
  • JobNotExist: -1
    +
  • Defined in enums/error-code.ts:2
  • JobNotInState: -3
    +
  • Defined in enums/error-code.ts:4
  • JobPendingDependencies: -4
    +
  • Defined in enums/error-code.ts:5
  • ParentJobNotExist: -5
    +
  • Defined in enums/error-code.ts:6
  • @@ -17,7 +17,7 @@
  • MetricsTime
  • Enumeration MetricsTime

    +
  • Defined in enums/metrics-time.ts:1
  • @@ -40,42 +40,42 @@

    Enumeration Members

    FIFTEEN_MINUTES: 15
    +
  • Defined in enums/metrics-time.ts:4
  • FIVE_MINUTES: 5
    +
  • Defined in enums/metrics-time.ts:3
  • ONE_HOUR: 60
    +
  • Defined in enums/metrics-time.ts:6
  • ONE_MINUTE: 1
    +
  • Defined in enums/metrics-time.ts:2
  • ONE_MONTH: 80640
    +
  • Defined in enums/metrics-time.ts:9
  • ONE_WEEK: 10080
    +
  • Defined in enums/metrics-time.ts:7
  • THIRTY_MINUTES: 30
    +
  • Defined in enums/metrics-time.ts:5
  • TWO_WEEKS: 20160
    +
  • Defined in enums/metrics-time.ts:8
  • @@ -17,7 +17,7 @@
  • ParentCommand
  • Enumeration ParentCommand

    +
  • Defined in enums/parent-command.ts:1
  • @@ -41,47 +41,47 @@

    Enumeration Members

    Completed: 0
    +
  • Defined in enums/parent-command.ts:2
  • Error: 1
    +
  • Defined in enums/parent-command.ts:3
  • Failed: 2
    +
  • Defined in enums/parent-command.ts:4
  • InitCompleted: 4
    +
  • Defined in enums/parent-command.ts:6
  • InitFailed: 3
    +
  • Defined in enums/parent-command.ts:5
  • Log: 5
    +
  • Defined in enums/parent-command.ts:7
  • MoveToDelayed: 6
    +
  • Defined in enums/parent-command.ts:8
  • Progress: 7
    +
  • Defined in enums/parent-command.ts:9
  • Update: 8
    +
  • Defined in enums/parent-command.ts:10
  • @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -48,7 +48,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -45,7 +45,7 @@

    Member Visibility

    Theme

    @@ -49,7 +49,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -45,7 +45,7 @@

    Member Visibility

    Theme

    @@ -56,7 +56,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -48,7 +48,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -45,7 +45,7 @@

    Member Visibility

    Theme

    @@ -49,7 +49,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -45,7 +45,7 @@

    Member Visibility

    Theme

    @@ -56,7 +56,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -48,7 +48,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -43,7 +43,7 @@

    Member Visibility

    Theme

    @@ -46,7 +46,7 @@

    Member Visibility

    Theme

    @@ -44,7 +44,7 @@

    Member Visibility

    Theme

    @@ -41,7 +41,7 @@

    Member Visibility

    Theme

    @@ -45,7 +45,7 @@

    Member Visibility

    Theme

    @@ -56,7 +56,7 @@

    Member Visibility

    Theme

    @@ -27,7 +27,7 @@

    Parameters

    arr: string[]

    Returns Record<string, string>

    +
  • Defined in utils.ts:46
  • @@ -34,7 +34,7 @@
    proc: msg: any

    Returns Promise<void>

    +
  • Defined in utils.ts:159
  • @@ -29,7 +29,7 @@
    proc: msg: ChildMessage

    Returns Promise<void>

    +
  • Defined in utils.ts:180
  • @@ -29,7 +29,7 @@
    emitter: count: number

    Returns void

    +
  • Defined in utils.ts:90
  • @@ -29,7 +29,7 @@
    ms: Optional abortController: AbortController

    Returns Promise<void>

    +
  • Defined in utils.ts:54
  • @@ -27,7 +27,7 @@

    Parameters

    value: any

    Returns Record<string, any>

    +
  • Defined in utils.ts:205
  • @@ -29,7 +29,7 @@
    millis: opts: RepeatOptions

    Returns number

    +
  • Defined in classes/repeat.ts:238
  • @@ -32,7 +32,7 @@
    id
    queue: string

    Returns string | undefined

    +
  • Defined in utils.ts:130
  • @@ -29,7 +29,7 @@
    emitter: count: number

    Returns void

    +
  • Defined in utils.ts:82
  • @@ -27,7 +27,7 @@

    Parameters

    obj: object

    Returns boolean

    +
  • Defined in utils.ts:37
  • @@ -27,7 +27,7 @@

    Parameters

    error: Error

    Returns boolean

    +
  • Defined in utils.ts:146
  • @@ -27,7 +27,7 @@

    Parameters

    obj: unknown

    Returns obj is Cluster

    +
  • Defined in utils.ts:78
  • @@ -27,7 +27,7 @@

    Parameters

    obj: any

    Returns obj is Cluster | Redis

    +
  • Defined in utils.ts:70
  • @@ -29,7 +29,7 @@
    currentVersion: minimumVersion: string

    Returns boolean

    +
  • Defined in utils.ts:185
  • @@ -32,7 +32,7 @@

    Returns numberSee

    https://stackoverflow.com/a/23318053/1347170

    +
  • Defined in utils.ts:33
  • @@ -30,7 +30,7 @@
    obj: [key: string]: string

    Returns Record<string, any>

    +
  • Defined in utils.ts:194
  • @@ -27,7 +27,7 @@

    Parameters

    raw: any[]

    Returns any[]

    +
  • Defined in classes/scripts.ts:1054
  • @@ -31,7 +31,7 @@
    queueName: prefix: string = ...

    Returns Promise<void | boolean>

    +
  • Defined in utils.ts:97
  • @@ -42,7 +42,7 @@
    ctx: args: any[]

    Returns any

    +
  • Defined in utils.ts:15
  • -

    bullmq - v4.15.3

    +

    bullmq - v4.15.4


    @@ -375,7 +375,7 @@

    Contributing
  • Thanks
  • @@ -89,7 +89,7 @@

    parent
  • queuesOpts
  • @@ -92,7 +92,7 @@

    parent
  • queuesOpts
  • @@ -75,7 +75,7 @@

    backoffStrategies
  • repeatStrategy
  • @@ -61,7 +61,7 @@

    repeatStrategy

    @@ -75,7 +75,7 @@

    delay
  • type
  • @@ -182,7 +182,7 @@

    stackTraceLimit
  • timestamp
  • @@ -70,7 +70,7 @@

    err
  • value
  • @@ -58,7 +58,7 @@

    processFile

    @@ -70,7 +70,7 @@

    name
  • options
  • @@ -77,7 +77,7 @@

    processed
  • unprocessed
  • @@ -91,7 +91,7 @@

    prefix
  • queueName
  • @@ -59,7 +59,7 @@

    queuesOptions

    @@ -95,7 +95,7 @@

    error
  • ioredis:close
  • @@ -56,7 +56,7 @@

    block

    @@ -73,7 +73,7 @@

    client
  • waitUntilReady
  • @@ -74,7 +74,7 @@

    ioredis:close

    @@ -98,7 +98,7 @@

    next
  • tz
  • @@ -154,7 +154,7 @@

    stacktrace
  • timestamp
  • @@ -161,7 +161,7 @@

    stacktrace
  • timestamp
  • @@ -63,7 +63,7 @@

    children
  • job
  • @@ -62,7 +62,7 @@

    cancel

    @@ -251,7 +251,7 @@

    stackTraceLimit
  • timestamp
  • @@ -76,7 +76,7 @@

    age
  • count
  • @@ -79,7 +79,7 @@

    data
  • meta
  • @@ -61,7 +61,7 @@

    maxDataPoints

    @@ -63,7 +63,7 @@

    child

    @@ -99,7 +99,7 @@

    prefix
  • queueName
  • @@ -73,7 +73,7 @@

    count
  • force
  • @@ -93,7 +93,7 @@

    prefix
  • queue
  • @@ -63,7 +63,7 @@

    id
  • queueKey
  • @@ -77,7 +77,7 @@

    job
  • value
  • @@ -99,7 +99,7 @@

    prefix
  • sharedConnection
  • @@ -555,7 +555,7 @@

    waiting
  • waiting-children
  • @@ -131,7 +131,7 @@

    prefix
  • sharedConnection
  • @@ -242,7 +242,7 @@

    resumed
  • waiting
  • @@ -156,7 +156,7 @@

    sharedConnection
  • streams
  • @@ -149,7 +149,7 @@

    ioredis:close
  • stalled
  • @@ -136,7 +136,7 @@

    sharedConnection
  • stalledInterval
  • @@ -101,7 +101,7 @@

    max
  • workerDelay
  • @@ -106,7 +106,7 @@

    settings
  • sharedConnection
  • @@ -141,7 +141,7 @@

    pattern
  • prevMillis
  • @@ -267,7 +267,7 @@

    update
  • updateProgress
  • @@ -111,7 +111,7 @@

    path
  • token
  • @@ -38,7 +38,7 @@

    Member Visibility

    Theme

    @@ -317,7 +317,7 @@

    progress
  • resumed
  • @@ -188,7 +188,7 @@

    sharedConnection
  • skipDelayCheck
  • @@ -89,7 +89,7 @@

    parent
  • queuesOpts
  • @@ -92,7 +92,7 @@

    parent
  • queuesOpts
  • @@ -75,7 +75,7 @@

    backoffStrategies
  • repeatStrategy
  • @@ -61,7 +61,7 @@

    repeatStrategy

    @@ -75,7 +75,7 @@

    delay
  • type
  • @@ -251,7 +251,7 @@

    stackTraceLimit
  • timestamp
  • @@ -70,7 +70,7 @@

    err
  • value
  • @@ -58,7 +58,7 @@

    processFile

    @@ -70,7 +70,7 @@

    name
  • options
  • @@ -182,7 +182,7 @@

    stackTraceLimit
  • timestamp
  • @@ -77,7 +77,7 @@

    processed
  • unprocessed
  • @@ -59,7 +59,7 @@

    queuesOptions

    @@ -95,7 +95,7 @@

    error
  • ioredis:close
  • @@ -56,7 +56,7 @@

    block

    @@ -73,7 +73,7 @@

    client
  • waitUntilReady
  • @@ -73,7 +73,7 @@

    ioredis:close

    @@ -154,7 +154,7 @@

    stacktrace
  • timestamp
  • @@ -161,7 +161,7 @@

    stacktrace
  • timestamp
  • @@ -63,7 +63,7 @@

    children
  • job
  • @@ -76,7 +76,7 @@

    age
  • count
  • @@ -79,7 +79,7 @@

    data
  • meta
  • @@ -61,7 +61,7 @@

    maxDataPoints

    @@ -63,7 +63,7 @@

    child

    @@ -99,7 +99,7 @@

    prefix
  • queueName
  • @@ -73,7 +73,7 @@

    count
  • force
  • @@ -93,7 +93,7 @@

    prefix
  • queue
  • @@ -63,7 +63,7 @@

    id
  • queueKey
  • @@ -77,7 +77,7 @@

    job
  • value
  • @@ -98,7 +98,7 @@

    prefix
  • sharedConnection
  • @@ -551,7 +551,7 @@

    waiting
  • waiting-children
  • @@ -131,7 +131,7 @@

    prefix
  • sharedConnection
  • @@ -242,7 +242,7 @@

    resumed
  • waiting
  • @@ -156,7 +156,7 @@

    sharedConnection
  • streams
  • @@ -101,7 +101,7 @@

    max
  • workerDelay
  • @@ -70,7 +70,7 @@

    keys
  • name
  • @@ -106,7 +106,7 @@

    settings
  • sharedConnection
  • @@ -141,7 +141,7 @@

    pattern
  • prevMillis
  • @@ -239,7 +239,7 @@

    update
  • updateProgress
  • @@ -111,7 +111,7 @@

    path
  • token
  • @@ -38,7 +38,7 @@

    Member Visibility

    Theme

    @@ -344,7 +344,7 @@

    resumed
  • stalled
  • @@ -210,7 +210,7 @@

    skipDelayCheck
  • stalledInterval
  • @@ -89,7 +89,7 @@

    parent
  • queuesOpts
  • @@ -92,7 +92,7 @@

    parent
  • queuesOpts
  • @@ -72,7 +72,7 @@

    backoffStrategy
  • repeatStrategy
  • @@ -61,7 +61,7 @@

    repeatStrategy

    @@ -75,7 +75,7 @@

    delay
  • type
  • @@ -255,7 +255,7 @@

    stackTraceLimit
  • timestamp
  • @@ -56,7 +56,7 @@

    skipVersionCheck

    @@ -49,7 +49,7 @@

    Member Visibility

    Theme

    @@ -70,7 +70,7 @@

    err
  • value
  • @@ -70,7 +70,7 @@

    name
  • options
  • @@ -181,7 +181,7 @@

    stackTraceLimit
  • timestamp
  • @@ -77,7 +77,7 @@

    processed
  • unprocessed
  • @@ -96,7 +96,7 @@

    prefix
  • queueName
  • @@ -59,7 +59,7 @@

    queuesOptions

    @@ -95,7 +95,7 @@

    error
  • ioredis:close
  • @@ -56,7 +56,7 @@

    block

    @@ -73,7 +73,7 @@

    client
  • waitUntilReady
  • @@ -73,7 +73,7 @@

    ioredis:close

    @@ -154,7 +154,7 @@

    stacktrace
  • timestamp
  • @@ -161,7 +161,7 @@

    stacktrace
  • timestamp
  • @@ -63,7 +63,7 @@

    children
  • job
  • @@ -76,7 +76,7 @@

    age
  • count
  • @@ -79,7 +79,7 @@

    data
  • meta
  • @@ -61,7 +61,7 @@

    maxDataPoints

    @@ -368,7 +368,7 @@

    update
  • updateProgress
  • @@ -63,7 +63,7 @@

    child

    @@ -99,7 +99,7 @@

    prefix
  • queueName
  • @@ -73,7 +73,7 @@

    count
  • force
  • @@ -93,7 +93,7 @@

    prefix
  • queue
  • @@ -63,7 +63,7 @@

    id
  • queueKey
  • @@ -77,7 +77,7 @@

    job
  • value
  • @@ -98,7 +98,7 @@

    prefix
  • sharedConnection
  • @@ -580,7 +580,7 @@

    waiting
  • waiting-children
  • @@ -131,7 +131,7 @@

    prefix
  • sharedConnection
  • @@ -242,7 +242,7 @@

    resumed
  • waiting
  • @@ -137,7 +137,7 @@

    sharedConnection
  • streams
  • @@ -71,7 +71,7 @@

    duration
  • max
  • @@ -70,7 +70,7 @@

    keys
  • name
  • @@ -106,7 +106,7 @@

    settings
  • sharedConnection
  • @@ -130,7 +130,7 @@

    pattern
  • prevMillis
  • @@ -239,7 +239,7 @@

    update
  • updateProgress
  • @@ -111,7 +111,7 @@

    path
  • token
  • @@ -365,7 +365,7 @@

    resumed
  • stalled
  • @@ -313,7 +313,7 @@

    stalledInterval
  • useWorkerThreads
  • @@ -21,7 +21,7 @@

    Hierarchy

    • AddChildrenOpts
    +
  • Defined in classes/flow-producer.ts:34
  • @@ -40,12 +40,12 @@

    Properties

    multi: ChainableCommander
    +
  • Defined in classes/flow-producer.ts:35
  • nodes: FlowJob[]
    +
  • Defined in classes/flow-producer.ts:36
  • parent: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }
    @@ -62,12 +62,12 @@
    id
  • queue: string
  • +
  • Defined in classes/flow-producer.ts:37
  • queuesOpts?: FlowQueuesOpts
    +
  • Defined in classes/flow-producer.ts:44
  • @@ -21,7 +21,7 @@

    Hierarchy

    • AddNodeOpts
    +
  • Defined in classes/flow-producer.ts:18
  • @@ -40,12 +40,12 @@

    Properties

    multi: ChainableCommander
    +
  • Defined in classes/flow-producer.ts:19
  • node: FlowJob
    +
  • Defined in classes/flow-producer.ts:20
  • parent?: {
        parentDependenciesKey: string;
        parentOpts: {
            id: string;
            queue: string;
        };
    }
    @@ -62,7 +62,7 @@
    id
  • queue: string
  • +
  • Defined in classes/flow-producer.ts:21
  • queuesOpts?: FlowQueuesOpts
    @@ -70,7 +70,7 @@
    +
  • Defined in classes/flow-producer.ts:31
  • @@ -23,7 +23,7 @@

    Hierarchy

    • AdvancedOptions
    +
  • Defined in interfaces/advanced-options.ts:16
  • @@ -44,7 +44,7 @@
    +
  • Defined in interfaces/advanced-options.ts:20
  • repeatKeyHashAlgorithm?: string
    @@ -54,7 +54,7 @@
    +
  • Defined in interfaces/advanced-options.ts:13
  • repeatStrategy?: RepeatStrategy
    @@ -63,7 +63,7 @@
    +
  • Defined in interfaces/advanced-options.ts:7
  • @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in interfaces/advanced-options.ts:3
  • @@ -44,7 +44,7 @@
    +
  • Defined in interfaces/advanced-options.ts:13
  • repeatStrategy?: RepeatStrategy
    @@ -52,7 +52,7 @@
    +
  • Defined in interfaces/advanced-options.ts:7
  • @@ -27,7 +27,7 @@

    Hierarchy

    • BackoffOptions
    +
  • Defined in interfaces/backoff-options.ts:6
  • @@ -47,7 +47,7 @@
    +
  • Defined in interfaces/backoff-options.ts:14
  • type: "fixed" | "exponential" | string & {}
    @@ -55,7 +55,7 @@
    +
  • Defined in interfaces/backoff-options.ts:10
  • @@ -23,7 +23,7 @@

    Hierarchy

    • BaseJobOptions
    +
  • Defined in interfaces/base-job-options.ts:77
  • @@ -61,7 +61,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/base-job-options.ts:29
  • backoff?: number | BackoffOptions
    @@ -70,7 +70,7 @@
    +
  • Defined in interfaces/base-job-options.ts:34
  • delay?: number
    @@ -84,7 +84,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/base-job-options.ts:23
  • jobId?: string
    @@ -96,7 +96,7 @@
    +
  • Defined in interfaces/base-job-options.ts:95
  • keepLogs?: number
    @@ -105,7 +105,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -116,7 +116,7 @@

    See

    https://docs.bul

    +
  • Defined in interfaces/base-job-options.ts:41
  • parent?: {
        id: string;
        queue: string;
    }
    @@ -133,7 +133,7 @@
    queuehttps://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html

    +
  • Defined in interfaces/base-job-options.ts:100
  • prevMillis?: number
    @@ -141,7 +141,7 @@
    +
  • Defined in interfaces/base-job-options.ts:113
  • priority?: number
    @@ -152,7 +152,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -165,7 +165,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -178,7 +178,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • repeat?: RepeatOptions
    @@ -186,7 +186,7 @@
    +
  • Defined in interfaces/base-job-options.ts:81
  • repeatJobKey?: string
    @@ -194,7 +194,7 @@
    +
  • Defined in interfaces/base-job-options.ts:86
  • sizeLimit?: number
    @@ -203,7 +203,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -212,7 +212,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -224,7 +224,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
  • @@ -21,7 +21,7 @@

    Hierarchy

    • BaseOptions
    +
  • Defined in interfaces/redis-options.ts:3
  • @@ -37,7 +37,7 @@

    Properties

    skipVersionCheck?: boolean
    +
  • Defined in interfaces/redis-options.ts:4
  • @@ -35,7 +35,7 @@

    Parameters

    delay: number

    Returns BackoffStrategy

    +
  • Defined in classes/backoffs.ts:4
  • @@ -21,7 +21,7 @@

    Hierarchy

    • ChildMessage
    +
  • Defined in interfaces/child-message.ts:3
  • @@ -39,17 +39,17 @@

    Properties

    +
  • Defined in interfaces/child-message.ts:4
  • err?: Record<string, any>
    +
  • Defined in interfaces/child-message.ts:6
  • value?: any
    +
  • Defined in interfaces/child-message.ts:5
  • @@ -21,7 +21,7 @@

    Hierarchy

    • Command
    +
  • Defined in commands/script-loader.ts:15
  • @@ -38,7 +38,7 @@

    Properties

    name: string
    +
  • Defined in commands/script-loader.ts:16
  • options: {
        lua: string;
        numberOfKeys: number;
    }
    @@ -50,7 +50,7 @@
    lua
    numberOfKeys: number
    +
  • Defined in commands/script-loader.ts:17
  • @@ -23,7 +23,7 @@

    Hierarchy

    +
  • Defined in interfaces/base-job-options.ts:3
  • @@ -55,7 +55,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/base-job-options.ts:29
  • backoff?: number | BackoffOptions
    @@ -63,7 +63,7 @@
    +
  • Defined in interfaces/base-job-options.ts:34
  • delay?: number
    @@ -76,7 +76,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/base-job-options.ts:23
  • keepLogs?: number
    @@ -84,7 +84,7 @@
    +
  • Defined in interfaces/base-job-options.ts:64
  • lifo?: boolean
    @@ -94,7 +94,7 @@

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

    +
  • Defined in interfaces/base-job-options.ts:41
  • priority?: number
    @@ -104,7 +104,7 @@
    +
  • Defined in interfaces/base-job-options.ts:15
  • removeOnComplete?: number | boolean | KeepJobs
    @@ -116,7 +116,7 @@
    +
  • Defined in interfaces/base-job-options.ts:50
  • removeOnFail?: number | boolean | KeepJobs
    @@ -128,7 +128,7 @@
    +
  • Defined in interfaces/base-job-options.ts:59
  • sizeLimit?: number
    @@ -136,7 +136,7 @@
    +
  • Defined in interfaces/base-job-options.ts:74
  • stackTraceLimit?: number
    @@ -144,7 +144,7 @@
    +
  • Defined in interfaces/base-job-options.ts:69
  • timestamp?: number
    @@ -155,7 +155,7 @@

    Default Value

    Date
    +
  • Defined in interfaces/base-job-options.ts:8
  • @@ -21,7 +21,7 @@

    Hierarchy

    • DependenciesOpts
    +
  • Defined in interfaces/minimal-job.ts:14
  • @@ -45,7 +45,7 @@
    Optional
    Optional cursor?: number
    +
  • Defined in interfaces/minimal-job.ts:15
  • unprocessed?: {
        count?: number;
        cursor?: number;
    }
    @@ -57,7 +57,7 @@
    Optional
    Optional cursor?: number
    +
  • Defined in interfaces/minimal-job.ts:19
  • @@ -26,7 +26,7 @@

    Hierarchy

    • FlowJobBase
    +
  • Defined in interfaces/flow-job.ts:4
  • @@ -47,32 +47,32 @@

    Properties

    children?: FlowChildJob[]
    +
  • Defined in interfaces/flow-job.ts:10
  • data?: any
    +
  • Defined in interfaces/flow-job.ts:7
  • name: string
    +
  • Defined in interfaces/flow-job.ts:5
  • opts?: Omit<T, "repeat">
    +
  • Defined in interfaces/flow-job.ts:9
  • prefix?: string
    +
  • Defined in interfaces/flow-job.ts:8
  • queueName: string
    +
  • Defined in interfaces/flow-job.ts:6
  • @@ -21,7 +21,7 @@

    Hierarchy

    • FlowOpts
    +
  • Defined in interfaces/flow-job.ts:22
  • @@ -40,7 +40,7 @@
    +
  • Defined in interfaces/flow-job.ts:26
  • @@ -23,7 +23,7 @@

    Hierarchy

    • FlowProducerListener
    +
  • Defined in classes/flow-producer.ts:75
  • @@ -57,7 +57,7 @@
    failedReason: Returns void
    +
  • Defined in classes/flow-producer.ts:81
  • ioredis:close: (() => void)
    @@ -75,7 +75,7 @@

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • @@ -21,7 +21,7 @@

    Hierarchy

    • GetNextJobOptions
    +
  • Defined in interfaces/worker-options.ts:142
  • @@ -37,7 +37,7 @@

    Properties

    block?: boolean
    +
  • Defined in interfaces/worker-options.ts:143
  • @@ -23,7 +23,7 @@

    Hierarchy

    • IConnection
    +
  • Defined in interfaces/connection.ts:6
  • @@ -43,7 +43,7 @@

    Properties

    client: Promise<RedisClient>
    +
  • Defined in interfaces/connection.ts:8
  • Methods

    @@ -53,7 +53,7 @@
    +
  • Defined in interfaces/connection.ts:7
  • @@ -26,7 +26,7 @@

    Hierarchy

  • QueueListener
  • WorkerListener
  • +
  • Defined in interfaces/ioredis-events.ts:1
  • @@ -54,7 +54,7 @@

    Type declaration

    Returns void

    +
  • Defined in interfaces/ioredis-events.ts:7
  • @@ -21,7 +21,7 @@

    Hierarchy

    • JobJson
    +
  • Defined in interfaces/job-json.ts:4
  • @@ -51,77 +51,77 @@

    Properties

    attemptsMade: number
    +
  • Defined in interfaces/job-json.ts:10
  • data: string
    +
  • Defined in interfaces/job-json.ts:7
  • failedReason: string
    +
  • Defined in interfaces/job-json.ts:14
  • finishedOn?: number
    +
  • Defined in interfaces/job-json.ts:11
  • id: string
    +
  • Defined in interfaces/job-json.ts:5
  • name: string
    +
  • Defined in interfaces/job-json.ts:6
  • +
  • Defined in interfaces/job-json.ts:8
  • 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
  • progress: number | object
    +
  • Defined in interfaces/job-json.ts:9
  • repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19
  • 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
  • @@ -21,7 +21,7 @@

    Hierarchy

    • JobJsonRaw
    +
  • Defined in interfaces/job-json.ts:22
  • @@ -52,82 +52,82 @@

    Properties

    attemptsMade: string
    +
  • Defined in interfaces/job-json.ts:29
  • data: string
    +
  • Defined in interfaces/job-json.ts:25
  • delay: string
    +
  • Defined in interfaces/job-json.ts:26
  • failedReason: string
    +
  • Defined in interfaces/job-json.ts:33
  • finishedOn?: string
    +
  • Defined in interfaces/job-json.ts:30
  • id: string
    +
  • Defined in interfaces/job-json.ts:23
  • name: string
    +
  • Defined in interfaces/job-json.ts:24
  • opts: string
    +
  • Defined in interfaces/job-json.ts:27
  • parent?: string
    +
  • Defined in interfaces/job-json.ts:37
  • parentKey?: string
    +
  • Defined in interfaces/job-json.ts:36
  • processedOn?: string
    +
  • Defined in interfaces/job-json.ts:31
  • progress: string
    +
  • Defined in interfaces/job-json.ts:28
  • returnvalue: string
    +
  • Defined in interfaces/job-json.ts:35
  • rjk?: string
    +
  • Defined in interfaces/job-json.ts:38
  • stacktrace: string[]
    +
  • Defined in interfaces/job-json.ts:34
  • timestamp: string
    +
  • Defined in interfaces/job-json.ts:32
  • @@ -21,7 +21,7 @@

    Hierarchy

    • JobNode
    +
  • Defined in classes/flow-producer.ts:70
  • @@ -38,12 +38,12 @@

    Properties

    children?: JobNode[]
    +
  • Defined in classes/flow-producer.ts:72
  • job: Job<any, any, string>
    +
  • Defined in classes/flow-producer.ts:71
  • @@ -28,7 +28,7 @@

    Hierarchy

    • KeepJobs
    +
  • Defined in interfaces/keep-jobs.ts:8
  • @@ -48,7 +48,7 @@
    +
  • Defined in interfaces/keep-jobs.ts:12
  • count?: number
    @@ -56,7 +56,7 @@
    +
  • Defined in interfaces/keep-jobs.ts:17
  • @@ -21,7 +21,7 @@

    Hierarchy

    • Metrics
    +
  • Defined in interfaces/metrics.ts:1
  • @@ -39,12 +39,12 @@

    Properties

    count: number
    +
  • Defined in interfaces/metrics.ts:8
  • data: number[]
    +
  • Defined in interfaces/metrics.ts:7
  • meta: {
        count: number;
        prevCount: number;
        prevTS: number;
    }
    @@ -58,7 +58,7 @@
    prevCount
    prevTS: number
    +
  • Defined in interfaces/metrics.ts:2
  • @@ -21,7 +21,7 @@

    Hierarchy

    • MetricsOptions
    +
  • Defined in interfaces/metrics-options.ts:5
  • @@ -42,7 +42,7 @@
    +
  • Defined in interfaces/metrics-options.ts:11
  • @@ -38,7 +38,7 @@

    Implemented by

    +
  • Defined in interfaces/minimal-job.ts:28
  • @@ -89,7 +89,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/minimal-job.ts:74
  • data: DataType
    @@ -97,7 +97,7 @@
    +
  • Defined in interfaces/minimal-job.ts:40
  • delay: number
    @@ -108,7 +108,7 @@

    Default Value

    0
     
    +
  • Defined in interfaces/minimal-job.ts:65
  • failedReason: string
    @@ -116,7 +116,7 @@
    +
  • Defined in interfaces/minimal-job.ts:78
  • finishedOn?: number
    @@ -124,12 +124,12 @@
    +
  • Defined in interfaces/minimal-job.ts:82
  • id?: string
    +
  • Defined in interfaces/minimal-job.ts:45
  • name: NameType
    @@ -137,7 +137,7 @@
    +
  • Defined in interfaces/minimal-job.ts:36
  • @@ -145,7 +145,7 @@
    +
  • Defined in interfaces/minimal-job.ts:44
  • parent?: ParentKeys
    @@ -153,7 +153,7 @@
    +
  • Defined in interfaces/minimal-job.ts:94
  • parentKey?: string
    @@ -161,7 +161,7 @@
    +
  • Defined in interfaces/minimal-job.ts:90
  • processedOn?: number
    @@ -169,7 +169,7 @@
    +
  • Defined in interfaces/minimal-job.ts:86
  • progress: number | object
    @@ -180,7 +180,7 @@

    Default Value

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

    Default Value

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

    Default Value

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

    @@ -230,7 +230,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

    @@ -263,7 +263,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
  • @@ -21,7 +21,7 @@

    Hierarchy

    • MoveToWaitingChildrenOpts
    +
  • Defined in interfaces/minimal-job.ts:7
  • @@ -44,7 +44,7 @@
    id
  • queue: string
  • +
  • Defined in interfaces/minimal-job.ts:8
  • @@ -21,7 +21,7 @@

    Hierarchy

    • NodeOpts
    +
  • Defined in classes/flow-producer.ts:47
  • @@ -44,7 +44,7 @@
    +
  • Defined in classes/flow-producer.ts:63
  • id: string
    @@ -52,7 +52,7 @@
    +
  • Defined in classes/flow-producer.ts:59
  • maxChildren?: number
    @@ -60,7 +60,7 @@
    +
  • Defined in classes/flow-producer.ts:67
  • prefix?: string
    @@ -68,7 +68,7 @@
    +
  • Defined in classes/flow-producer.ts:55
  • queueName: string
    @@ -76,7 +76,7 @@
    +
  • Defined in classes/flow-producer.ts:51
  • @@ -21,7 +21,7 @@

    Hierarchy

    • ObliterateOpts
    +
  • Defined in classes/queue.ts:17
  • @@ -44,7 +44,7 @@

    Default Value

    1000
    +
  • Defined in classes/queue.ts:27
  • force?: boolean
    @@ -55,7 +55,7 @@

    Default Value

    false
    +
  • Defined in classes/queue.ts:22
  • @@ -30,7 +30,7 @@

    Hierarchy

    • Parent
    +
  • Defined in interfaces/parent.ts:5
  • @@ -50,27 +50,27 @@

    Properties

    data?: T
    +
  • Defined in interfaces/parent.ts:9
  • name: string
    +
  • Defined in interfaces/parent.ts:6
  • +
  • Defined in interfaces/parent.ts:10
  • prefix?: string
    +
  • Defined in interfaces/parent.ts:7
  • queue?: string
    +
  • Defined in interfaces/parent.ts:8
  • @@ -21,7 +21,7 @@

    Hierarchy

    • ParentKeys
    +
  • Defined in interfaces/parent.ts:13
  • @@ -38,12 +38,12 @@

    Properties

    id: string
    +
  • Defined in interfaces/parent.ts:14
  • queueKey: string
    +
  • Defined in interfaces/parent.ts:15
  • @@ -21,7 +21,7 @@

    Hierarchy

    • ParentMessage
    +
  • Defined in interfaces/parent-message.ts:4
  • @@ -40,22 +40,22 @@

    Properties

    +
  • Defined in interfaces/parent-message.ts:5
  • err?: Error
    +
  • Defined in interfaces/parent-message.ts:7
  • job?: JobJson
    +
  • Defined in interfaces/parent-message.ts:8
  • value?: any
    +
  • Defined in interfaces/parent-message.ts:6
  • @@ -30,7 +30,7 @@

    Hierarchy

  • QueueEventsOptions
  • WorkerOptions
  • +
  • Defined in interfaces/queue-options.ts:13
  • @@ -52,7 +52,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • connection?: ConnectionOptions
    @@ -60,7 +60,7 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • prefix?: string
    @@ -68,7 +68,7 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • skipVersionCheck?: boolean
    @@ -79,7 +79,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • @@ -23,7 +23,7 @@

    Hierarchy

    • QueueEventsListener
    +
  • Defined in classes/queue-events.ts:16
  • @@ -80,7 +80,7 @@
    id: Returns void
    +
  • Defined in classes/queue-events.ts:22
  • added: ((args, id) => void)
    @@ -109,7 +109,7 @@
    id: Returns void
    +
  • 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
  • @@ -27,7 +27,7 @@

    Hierarchy

    • QueueEventsOptions
    +
  • Defined in interfaces/queue-options.ts:70
  • @@ -52,7 +52,7 @@
    +
  • Defined in interfaces/queue-options.ts:74
  • blockingConnection?: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • blockingTimeout?: number
    @@ -69,7 +69,7 @@
    +
  • Defined in interfaces/queue-options.ts:85
  • connection?: ConnectionOptions
    @@ -78,7 +78,7 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • lastEventId?: string
    @@ -88,7 +88,7 @@
    +
  • Defined in interfaces/queue-options.ts:80
  • prefix?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • skipVersionCheck?: boolean
    @@ -109,7 +109,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • @@ -32,7 +32,7 @@

    Hierarchy

    • QueueListener
    +
  • Defined in classes/queue.ts:30
  • @@ -74,7 +74,7 @@
    type: Returns void
    +
  • Defined in classes/queue.ts:37
  • error: ((err) => void)
    @@ -96,7 +96,7 @@
    err: Returns void
    +
  • 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
  • @@ -27,7 +27,7 @@

    Hierarchy

    • QueueOptions
    +
  • Defined in interfaces/queue-options.ts:39
  • @@ -53,7 +53,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • connection?: ConnectionOptions
    @@ -62,12 +62,12 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • defaultJobOptions?: DefaultJobOptions
    +
  • Defined in interfaces/queue-options.ts:40
  • prefix?: string
    @@ -76,12 +76,12 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • +
  • Defined in interfaces/queue-options.ts:57
  • skipVersionCheck?: boolean
    @@ -93,7 +93,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • streams?: {
        events: {
            maxLen: number;
        };
    }
    @@ -115,7 +115,7 @@
    maxLen
    +
  • Defined in interfaces/queue-options.ts:45
  • @@ -21,7 +21,7 @@

    Hierarchy

    • RateLimiterOptions
    +
  • Defined in interfaces/rate-limiter-options.ts:1
  • @@ -42,7 +42,7 @@
    +
  • Defined in interfaces/rate-limiter-options.ts:12
  • max: number
    @@ -51,7 +51,7 @@
    +
  • Defined in interfaces/rate-limiter-options.ts:6
  • @@ -21,7 +21,7 @@

    Hierarchy

    • RawCommand
    +
  • Defined in classes/redis-connection.ts:31
  • @@ -39,17 +39,17 @@

    Properties

    content: string
    +
  • Defined in classes/redis-connection.ts:32
  • keys: number
    +
  • Defined in classes/redis-connection.ts:34
  • name: string
    +
  • Defined in classes/redis-connection.ts:33
  • @@ -27,7 +27,7 @@

    Hierarchy

    • RepeatBaseOptions
    +
  • Defined in interfaces/queue-options.ts:63
  • @@ -51,7 +51,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • connection?: ConnectionOptions
    @@ -60,7 +60,7 @@
    +
  • Defined in interfaces/queue-options.ts:17
  • prefix?: string
    @@ -69,12 +69,12 @@
    +
  • Defined in interfaces/queue-options.ts:27
  • +
  • Defined in interfaces/queue-options.ts:64
  • skipVersionCheck?: boolean
    @@ -86,7 +86,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • @@ -29,7 +29,7 @@

    Hierarchy

    • RepeatOptions
    +
  • Defined in interfaces/repeat-options.ts:8
  • @@ -55,7 +55,7 @@
    +
  • Defined in interfaces/repeat-options.ts:30
  • every?: number
    @@ -64,7 +64,7 @@
    +
  • Defined in interfaces/repeat-options.ts:21
  • immediately?: boolean
    @@ -73,12 +73,12 @@
    +
  • Defined in interfaces/repeat-options.ts:26
  • jobId?: string
    +
  • Defined in interfaces/repeat-options.ts:33
  • limit?: number
    @@ -86,12 +86,12 @@
    +
  • Defined in interfaces/repeat-options.ts:16
  • offset?: number
    +
  • Defined in interfaces/repeat-options.ts:32
  • pattern?: string
    @@ -99,12 +99,12 @@
    +
  • Defined in interfaces/repeat-options.ts:12
  • prevMillis?: number
    +
  • Defined in interfaces/repeat-options.ts:31
  • @@ -34,7 +34,7 @@

    Hierarchy

    • SandboxedJob
    +
  • Defined in interfaces/sandboxed-job.ts:7
  • @@ -70,30 +70,30 @@
    +
  • Defined in interfaces/job-json.ts:10
  • data: T
    +
  • Defined in interfaces/sandboxed-job.ts:9
  • failedReason: string
    +
  • Defined in interfaces/job-json.ts:14
  • finishedOn?: number
    +
  • Defined in interfaces/job-json.ts:11
  • id: string
    +
  • Defined in interfaces/job-json.ts:5
  • log: ((row) => void)
    @@ -111,7 +111,7 @@

    Parameters

    row: any

    Returns void

    +
  • Defined in interfaces/sandboxed-job.ts:12
  • moveToDelayed: ((timestamp, token?) => Promise<void>)
    @@ -131,71 +131,71 @@
    timestamp: Optional token: string

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:11
  • 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
  • progress: number | object
    +
  • Defined in interfaces/job-json.ts:9
  • repeatJobKey?: string
    +
  • Defined in interfaces/job-json.ts:19
  • returnValue: R
    +
  • Defined in interfaces/sandboxed-job.ts:15
  • 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>)
    @@ -213,7 +213,7 @@

    Parameters

    data: any

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:13
  • updateProgress: ((value) => Promise<void>)
    @@ -231,7 +231,7 @@

    Parameters

    value: number | object

    Returns Promise<void>

    +
  • Defined in interfaces/sandboxed-job.ts:14
  • @@ -25,7 +25,7 @@

    Hierarchy

    • ScriptMetadata
    +
  • Defined in commands/script-loader.ts:26
  • @@ -49,7 +49,7 @@
    +
  • Defined in commands/script-loader.ts:41
  • includes: ScriptMetadata[]
    @@ -57,7 +57,7 @@
    +
  • Defined in commands/script-loader.ts:49
  • name: string
    @@ -65,12 +65,12 @@
    +
  • 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
  • @@ -32,7 +32,7 @@

    Hierarchy

    • WorkerListener
    +
  • Defined in classes/worker.ts:45
  • @@ -79,7 +79,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:55
  • closed: (() => void)
    @@ -96,7 +96,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:62
  • closing: ((msg) => void)
    @@ -118,7 +118,7 @@
    msg: Returns void
    +
  • Defined in classes/worker.ts:69
  • completed: ((job, result, prev) => void)
    @@ -144,7 +144,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:76
  • drained: (() => void)
    @@ -163,7 +163,7 @@

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:89
  • error: ((failedReason) => void)
    @@ -185,7 +185,7 @@
    failedReason: Returns void
    +
  • Defined in classes/worker.ts:96
  • failed: ((job, error, prev) => void)
    @@ -213,7 +213,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:105
  • 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:116
  • progress: ((job, progress) => void)
    @@ -275,7 +275,7 @@
    progress: Returns void
    +
  • Defined in classes/worker.ts:126
  • ready: (() => void)
    @@ -292,7 +292,7 @@

    Type declaration

    Returns void

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

    Type declaration

    Returns void

    +
  • Defined in classes/worker.ts:143
  • stalled: ((jobId, prev) => void)
    @@ -334,7 +334,7 @@
    prev: Returns void
    +
  • Defined in classes/worker.ts:151
  • @@ -27,7 +27,7 @@

    Hierarchy

    • WorkerOptions
    +
  • Defined in interfaces/worker-options.ts:16
  • @@ -68,7 +68,7 @@

    Default

    true
     
    +
  • Defined in interfaces/worker-options.ts:22
  • blockingConnection?: boolean
    @@ -77,7 +77,7 @@
    +
  • Defined in interfaces/queue-options.ts:22
  • 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:27
  • 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
  • skipLockRenewal?: boolean
    @@ -229,7 +229,7 @@

    Default

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

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:82
  • skipVersionCheck?: boolean
    @@ -254,7 +254,7 @@

    Default Value

    false
    +
  • Defined in interfaces/queue-options.ts:33
  • stalledInterval?: number
    @@ -265,7 +265,7 @@

    Default

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

    Default

    false
     
    +
  • Defined in interfaces/worker-options.ts:139
  • @@ -690,7 +690,7 @@

    StreamReadRaw
  • WaitingEventCallback3
  • @@ -484,7 +484,7 @@

    StreamName
  • StreamReadRaw
  • @@ -493,7 +493,7 @@

    StreamName
  • StreamReadRaw
  • @@ -175,7 +175,7 @@

    Member Visibility

    Theme

    @@ -37,7 +37,7 @@
    Optional Optional job: MinimalJob

    Returns Promise<number> | number

    +
  • Defined in types/backoff-strategy.ts:3
  • @@ -18,7 +18,7 @@

    Type alias BulkJobOptions

    BulkJobOptions: Omit<JobsOptions, "repeat">
    +
  • Defined in interfaces/minimal-job.ts:5
  • @@ -18,7 +18,7 @@

    Type alias ClusterOptions

    ClusterOptions: IORedis.ClusterOptions & BaseOptions
    +
  • Defined in interfaces/redis-options.ts:9
  • @@ -18,7 +18,7 @@

    Type alias ConnectionOptions

    ConnectionOptions: RedisOptions | ClusterOptions | IORedis.Redis | IORedis.Cluster
    +
  • Defined in interfaces/redis-options.ts:11
  • @@ -18,7 +18,7 @@

    Type alias EntryId

    EntryId: string
    +
  • Defined in interfaces/redis-streams.ts:6
  • @@ -18,7 +18,7 @@

    Type alias EntryRaw

    EntryRaw: [EntryId, string[]]
    +
  • Defined in interfaces/redis-streams.ts:7
  • @@ -18,7 +18,7 @@

    Type alias FinishedPropValAttribute

    FinishedPropValAttribute: "returnvalue" | "failedReason"
    +
  • Defined in types/finished-status.ts:3
  • @@ -18,7 +18,7 @@

    Type alias FinishedStatus

    FinishedStatus: "completed" | "failed"
    +
  • Defined in types/finished-status.ts:1
  • @@ -18,7 +18,7 @@

    Type alias FlowChildJob

    FlowChildJob: FlowJobBase<Omit<JobsOptions, "parent">>
    +
  • Defined in interfaces/flow-job.ts:13
  • @@ -18,7 +18,7 @@

    Type alias FlowJob

    +
  • Defined in interfaces/flow-job.ts:15
  • @@ -18,7 +18,7 @@

    Type alias FlowQueuesOpts

    FlowQueuesOpts: Record<string, Omit<QueueOptions, "connection" | "prefix">>
    +
  • Defined in interfaces/flow-job.ts:17
  • @@ -18,7 +18,7 @@

    Type alias JobData

    JobData: [JobJsonRaw | number, string?]
    +
  • Defined in classes/scripts.ts:38
  • @@ -25,7 +25,7 @@
    prefix
    queueName: string
    +
  • Defined in types/job-json-sandbox.ts:3
  • @@ -18,7 +18,7 @@

    Type alias JobState

    JobState: FinishedStatus | "active" | "delayed" | "prioritized" | "waiting" | "waiting-children"
    +
  • Defined in types/job-type.ts:3
  • @@ -18,7 +18,7 @@

    Type alias JobType

    JobType: JobState | "paused" | "repeat" | "wait"
    +
  • Defined in types/job-type.ts:11
  • @@ -31,7 +31,7 @@
    Optional
    +
  • Defined in types/job-options.ts:3
  • @@ -18,7 +18,7 @@

    Type alias KeysMap

    KeysMap: {
        [index in string]: string
    }
    +
  • Defined in classes/queue-keys.ts:1
  • @@ -18,7 +18,7 @@

    Type alias MinimalQueue

    MinimalQueue: Pick<QueueBase, "name" | "client" | "toKey" | "keys" | "opts" | "qualifiedName" | "closing" | "waitUntilReady" | "removeListener" | "emit" | "on" | "redisVersion">
    +
  • Defined in types/minimal-queue.ts:3
  • @@ -27,7 +27,7 @@
    Optional
    Optional waitChildrenKey?: string
    +
  • Defined in interfaces/parent.ts:18
  • @@ -45,7 +45,7 @@
    Optional Returns Promise<R>
    +
  • Defined in interfaces/worker-options.ts:11
  • @@ -18,7 +18,7 @@

    Type alias RedisClient

    RedisClient: Redis | Cluster
    +
  • Defined in interfaces/connection.ts:4
  • @@ -39,7 +39,7 @@
    Optional
    +
  • Defined in types/job-options.ts:18
  • @@ -18,7 +18,7 @@

    Type alias RedisOptions

    RedisOptions: IORedis.RedisOptions & BaseOptions
    +
  • Defined in interfaces/redis-options.ts:7
  • +
  • Defined in types/repeat-strategy.ts:3
  • @@ -35,7 +35,7 @@
    pattern
    tz: string | null
    +
  • Defined in interfaces/repeatable-job.ts:1
  • +
  • Defined in interfaces/sandboxed-job-processor.ts:6
  • @@ -18,7 +18,7 @@

    Type alias StreamName

    StreamName: string
    +
  • Defined in interfaces/redis-streams.ts:5
  • @@ -18,7 +18,7 @@

    Type alias StreamReadRaw

    StreamReadRaw: [StreamName, EntryRaw[]][] | null | undefined
    +
  • Defined in interfaces/redis-streams.ts:8
  • @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -37,7 +37,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -37,7 +37,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -37,7 +37,7 @@

    Member Visibility

    Theme

    @@ -32,7 +32,7 @@

    Member Visibility

    Theme

    @@ -18,7 +18,7 @@

    Variable DELAY_TIME_1Const

    DELAY_TIME_1: 100 = 100
    +
  • Defined in utils.ts:144
  • @@ -18,7 +18,7 @@

    Variable DELAY_TIME_5Const

    DELAY_TIME_5: 5000 = 5000
    +
  • Defined in utils.ts:142
  • @@ -18,7 +18,7 @@

    Variable PRIORITY_LIMITConst

    PRIORITY_LIMIT: number = ...
    +
  • Defined in classes/job.ts:48
  • @@ -18,7 +18,7 @@

    Variable QUEUE_EVENT_SUFFIXConst

    QUEUE_EVENT_SUFFIX: ":qe" = ':qe'
    +
  • Defined in utils.ts:217
  • @@ -18,7 +18,7 @@

    Variable RATE_LIMIT_ERRORConst

    RATE_LIMIT_ERROR: "bullmq:rateLimitExceeded" = 'bullmq:rateLimitExceeded'
    +
  • Defined in classes/errors/rate-limit-error.ts:1
  • @@ -18,7 +18,7 @@

    Variable WORKER_SUFFIXConst

    WORKER_SUFFIX: "" = ''
    +
  • Defined in utils.ts:215
  • @@ -18,7 +18,7 @@

    Variable clientCommandMessageRegConst

    clientCommandMessageReg: RegExp = ...
    +
  • Defined in utils.ts:139
  • @@ -23,7 +23,7 @@

    Type declaration

  • [index: string]: any
  • +
  • Defined in utils.ts:13
  • @@ -18,7 +18,7 @@

    Variable scriptLoaderConst

    scriptLoader: ScriptLoader = ...
    +
  • Defined in commands/index.ts:4