🛠 Tutorials
Official Front End
+🚀 Sponsors 🚀
Used by
The gist
Feature Comparison
diff --git a/interfaces/v4.AddChildrenOpts.html b/interfaces/v4.AddChildrenOpts.html
index 02088aeb12..287bab1605 100644
--- a/interfaces/v4.AddChildrenOpts.html
+++ b/interfaces/v4.AddChildrenOpts.html
@@ -21,7 +21,7 @@ Hierarchy
+Defined in classes/flow-producer.ts:34
+Defined in classes/flow-producer.ts:36
parent
parent : { parentDependenciesKey : string ; parentOpts : { id : string ; queue : string ; } ; }
@@ -62,12 +62,12 @@
+Defined in classes/flow-producer.ts:37
+Defined in classes/flow-producer.ts:44
+Defined in interfaces/advanced-options.ts:7
+Defined in interfaces/base-job-options.ts:64
+Defined in interfaces/base-job-options.ts:41
Optional
parent
parent ?: { id : string ; queue : string ; }
@@ -133,7 +133,7 @@ queue https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+Defined in interfaces/base-job-options.ts:100
Optional
prev Millis
prev Millis ?: number
@@ -141,7 +141,7 @@ Optional
+Defined in interfaces/base-job-options.ts:113
Optional
priority
priority ?: number
@@ -152,7 +152,7 @@ Optional
+Defined in interfaces/base-job-options.ts:15
Optional
remove On Complete
remove On Complete ?: number | boolean | KeepJobs
@@ -165,7 +165,7 @@ Optional
+Defined in interfaces/base-job-options.ts:50
Optional
remove On Fail
remove On Fail ?: number | boolean | KeepJobs
@@ -178,7 +178,7 @@ Optional
+Defined in interfaces/base-job-options.ts:59
Optional
repeat
@@ -186,7 +186,7 @@ Optional
+Defined in interfaces/base-job-options.ts:81
Optional
repeat Job Key
repeat Job Key ?: string
@@ -194,7 +194,7 @@ Optional
+Defined in interfaces/base-job-options.ts:86
Optional
size Limit
size Limit ?: number
@@ -203,7 +203,7 @@ Optional
+Defined in interfaces/base-job-options.ts:74
Optional
stack Trace Limit
stack Trace Limit ?: number
@@ -212,7 +212,7 @@ Optional
+Defined in interfaces/base-job-options.ts:69
Optional
timestamp
timestamp ?: number
@@ -224,7 +224,7 @@ Default Value Date
+Defined in interfaces/base-job-options.ts:8
+Defined in interfaces/base-job-options.ts:8
+Defined in interfaces/minimal-job.ts:19
+Defined in interfaces/ioredis-events.ts:7
+Defined in interfaces/minimal-job.ts:131
+Defined in interfaces/minimal-job.ts:127
+Defined in interfaces/minimal-job.ts:136
+Defined in interfaces/minimal-job.ts:108
log
@@ -293,7 +293,7 @@ logRow : Returns Promise < number >
+Defined in interfaces/minimal-job.ts:126
update Data
@@ -312,7 +312,7 @@ data : Returns Promise < void >
+Defined in interfaces/minimal-job.ts:114
update Progress
@@ -331,7 +331,7 @@ progress : Returns Promise < void >
+Defined in interfaces/minimal-job.ts:120
+Defined in classes/queue-events.ts:62
duplicated
duplicated : ( ( args , id ) => void )
@@ -247,7 +247,7 @@ id : Returns void
+Defined in classes/queue-events.ts:69
error
error : ( ( args ) => void )
@@ -269,7 +269,7 @@ args : Returns void
+Defined in classes/queue-events.ts:76
failed
failed : ( ( args , id ) => void )
@@ -300,7 +300,7 @@ id : Returns void
+Defined in classes/queue-events.ts:83
ioredis:close
ioredis:close : ( ( ) => void )
@@ -318,7 +318,7 @@ Returns void
+Defined in interfaces/ioredis-events.ts:7
paused
paused : ( ( args , id ) => void )
@@ -343,7 +343,7 @@ id : Returns void
+Defined in classes/queue-events.ts:93
progress
progress : ( ( args , id ) => void )
@@ -375,7 +375,7 @@ id : Returns void
+Defined in classes/queue-events.ts:103
removed
removed : ( ( args , id ) => void )
@@ -405,7 +405,7 @@ id : Returns void
+Defined in classes/queue-events.ts:114
resumed
resumed : ( ( args , id ) => void )
@@ -430,7 +430,7 @@ id : Returns void
+Defined in classes/queue-events.ts:121
retries- exhausted
retries- exhausted : ( ( args , id ) => void )
@@ -459,7 +459,7 @@ id : Returns void
+Defined in classes/queue-events.ts:128
stalled
stalled : ( ( args , id ) => void )
@@ -488,7 +488,7 @@ id : Returns void
+Defined in classes/queue-events.ts:140
waiting
waiting : ( ( args , id ) => void )
@@ -517,7 +517,7 @@ id : Returns void
+Defined in classes/queue-events.ts:147
waiting- children
waiting- children : ( ( args , id ) => void )
@@ -544,7 +544,7 @@ id : Returns void
+Defined in classes/queue-events.ts:154
+Defined in interfaces/queue-options.ts:27
Optional
skip Version Check
skip Version Check ?: boolean
@@ -109,7 +109,7 @@ Default Value false
+Defined in interfaces/queue-options.ts:33
+Defined in interfaces/ioredis-events.ts:7
paused
paused : ( ( ) => void )
@@ -131,7 +131,7 @@ Type declaration
Returns void
+Defined in classes/queue.ts:51
progress
progress : ( ( job , progress ) => void )
@@ -155,7 +155,7 @@ progress : Returns void
+Defined in classes/queue.ts:58
removed
removed : ( ( job ) => void )
@@ -177,7 +177,7 @@ job : Returns void
+Defined in classes/queue.ts:68
resumed
resumed : ( ( ) => void )
@@ -194,7 +194,7 @@ Type declaration
Returns void
+Defined in classes/queue.ts:75
waiting
waiting : ( ( job ) => void )
@@ -216,7 +216,7 @@ job : Returns void
+Defined in classes/queue.ts:82
+Defined in interfaces/queue-options.ts:27
+Defined in interfaces/queue-options.ts:57
Optional
skip Version Check
skip Version Check ?: boolean
@@ -93,7 +93,7 @@ Default Value false
+Defined in interfaces/queue-options.ts:33
Optional
streams
streams ?: { events : { maxLen : number ; } ; }
@@ -115,7 +115,7 @@ max Len
+Defined in interfaces/queue-options.ts:45
+Defined in interfaces/queue-options.ts:33
Returns Promise < void >
+Defined in interfaces/sandboxed-job.ts:11
+Defined in interfaces/job-json.ts:6
+Defined in interfaces/sandboxed-job.ts:10
+Defined in interfaces/job-json.ts:17
Optional
parent Key
parent Key ?: string
+Defined in interfaces/job-json.ts:18
Optional
processed On
processed On ?: number
+Defined in interfaces/job-json.ts:12
progress
progress : number | object
+Defined in interfaces/job-json.ts:9
Optional
repeat Job Key
repeat Job Key ?: string
+Defined in interfaces/job-json.ts:19
return Value
return Value : R
+Defined in interfaces/sandboxed-job.ts:15
returnvalue
returnvalue : string
+Defined in interfaces/job-json.ts:16
stacktrace
stacktrace : string
+Defined in interfaces/job-json.ts:15
timestamp
timestamp : number
+Defined in interfaces/job-json.ts:13
update Data
update Data : ( ( data ) => Promise < void > )
@@ -213,7 +213,7 @@ Parameters
data : any
Returns Promise < void >
+Defined in interfaces/sandboxed-job.ts:13
update Progress
update Progress : ( ( value ) => Promise < void > )
@@ -231,7 +231,7 @@ Parameters
value : number | object
Returns Promise < void >
+Defined in interfaces/sandboxed-job.ts:14
+Defined in commands/script-loader.ts:37
token
token : string
@@ -87,7 +87,7 @@ token
+Defined in commands/script-loader.ts:45
+Defined in classes/worker.ts:66
completed
completed : ( ( job , result , prev ) => void )
@@ -144,7 +144,7 @@ prev : Returns void
+Defined in classes/worker.ts:73
drained
drained : ( ( ) => void )
@@ -163,7 +163,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:86
error
error : ( ( failedReason ) => void )
@@ -185,7 +185,7 @@ failedReason : Returns void
+Defined in classes/worker.ts:93
failed
failed : ( ( job , error , prev ) => void )
@@ -213,7 +213,7 @@ prev : Returns void
+Defined in classes/worker.ts:102
ioredis:close
ioredis:close : ( ( ) => void )
@@ -231,7 +231,7 @@ Returns void
+Defined in interfaces/ioredis-events.ts:7
paused
paused : ( ( ) => void )
@@ -248,7 +248,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:113
progress
progress : ( ( job , progress ) => void )
@@ -275,7 +275,7 @@ progress : Returns void
+Defined in classes/worker.ts:123
ready
ready : ( ( ) => void )
@@ -292,7 +292,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:133
resumed
resumed : ( ( ) => void )
@@ -309,7 +309,7 @@ Type declaration
Returns void
+Defined in classes/worker.ts:140
stalled
stalled : ( ( jobId , prev ) => void )
@@ -334,7 +334,7 @@ prev : Returns void
+Defined in classes/worker.ts:148
+Defined in interfaces/worker-options.ts:31
Optional
connection
@@ -100,7 +100,7 @@ Optional
+Defined in interfaces/queue-options.ts:17
Optional
drain Delay
drain Delay ?: number
@@ -111,7 +111,7 @@ Default 5
Copy
+Defined in interfaces/worker-options.ts:99
+Defined in interfaces/worker-options.ts:37
Optional
lock Duration
lock Duration ?: number
@@ -135,7 +135,7 @@ Default 30000
Copy
+Defined in interfaces/worker-options.ts:110
Optional
lock Renew Time
lock Renew Time ?: number
@@ -145,7 +145,7 @@ Optional
+Defined in interfaces/worker-options.ts:118
Optional
max Stalled Count
max Stalled Count ?: number
@@ -158,7 +158,7 @@ Default 1
Copy
+Defined in interfaces/worker-options.ts:52
+Defined in interfaces/worker-options.ts:43
Optional
prefix
prefix ?: string
@@ -177,7 +177,7 @@ Optional
+Defined in interfaces/queue-options.ts:27
Optional
remove On Complete
@@ -187,7 +187,7 @@ Optional
+Defined in interfaces/worker-options.ts:66
Optional
remove On Fail
@@ -197,7 +197,7 @@ Optional
+Defined in interfaces/worker-options.ts:73
Optional
run Retry Delay
run Retry Delay ?: number
@@ -208,7 +208,7 @@ Default 15000
Copy
+Defined in interfaces/worker-options.ts:125
Optional
settings
@@ -216,7 +216,7 @@ Optional
+Defined in interfaces/worker-options.ts:130
Optional
skip Lock Renewal
skip Lock Renewal ?: boolean
@@ -229,7 +229,7 @@ Default false
Copy
+Defined in interfaces/worker-options.ts:91
Optional
skip Stalled Check
skip Stalled Check ?: boolean
@@ -242,7 +242,7 @@ Default false
Copy
+Defined in interfaces/worker-options.ts:82
Optional
skip Version Check
skip Version Check ?: boolean
@@ -254,7 +254,7 @@ Default Value false
+Defined in interfaces/queue-options.ts:33
Optional
stalled Interval
stalled Interval ?: number
@@ -265,7 +265,7 @@ Default 30000
Copy
+Defined in interfaces/worker-options.ts:59
Optional
use Worker Threads
use Worker Threads ?: boolean
@@ -278,7 +278,7 @@ Default false
Copy
+Defined in interfaces/worker-options.ts:139
+Defined in types/backoff-strategy.ts:3
+Defined in types/job-options.ts:3
+Defined in types/job-options.ts:18
+Defined in types/repeat-strategy.ts:3