bullmq - v6.0.3
Preparing search index...
v6
SandboxedJob
Interface SandboxedJob<T, R>
See
https://docs.bullmq.io/guide/workers/sandboxed-processors
interface
SandboxedJob
<
T
=
any
,
R
=
any
>
{
attemptsMade
:
number
;
attemptsStarted
:
number
;
data
:
T
;
debounceId
?:
string
;
deduplicationId
?:
string
;
deferredFailure
?:
string
;
delay
?:
number
;
failedReason
:
string
;
finishedOn
?:
number
;
getChildrenValues
:
<
CT
=
any
>
()
=>
Promise
<
{
[
jobKey
:
string
]:
CT
}
>
;
getDependenciesCount
:
(
opts
?:
{
failed
?:
boolean
;
ignored
?:
boolean
;
processed
?:
boolean
;
unprocessed
?:
boolean
;
}
,
)
=>
Promise
<
{
failed
?:
number
;
ignored
?:
number
;
processed
?:
number
;
unprocessed
?:
number
;
}
,
>
;
getIgnoredChildrenFailures
:
()
=>
Promise
<
{
[
jobKey
:
string
]:
string
}
>
;
id
:
string
;
log
:
(
row
:
string
)
=>
void
;
moveToDelayed
:
(
timestamp
:
number
,
token
?:
string
)
=>
Promise
<
void
>
;
moveToWait
:
(
token
?:
string
)
=>
Promise
<
void
>
;
moveToWaitingChildren
:
(
token
?:
string
,
opts
?:
MoveToWaitingChildrenOpts
,
)
=>
Promise
<
boolean
>
;
name
:
string
;
opts
:
JobsOptions
;
parent
?:
ParentKeys
;
parentKey
?:
string
;
prefix
:
string
;
priority
?:
number
;
processedBy
?:
string
;
processedOn
?:
number
;
progress
:
JobProgress
;
queueName
:
string
;
queueQualifiedName
:
string
;
repeatJobKey
?:
string
;
returnValue
:
R
;
stacktrace
?:
string
;
stalledCounter
:
number
;
timestamp
:
number
;
updateData
:
(
data
:
T
)
=>
Promise
<
void
>
;
updateProgress
:
(
value
:
JobProgress
)
=>
Promise
<
void
>
;
}
Type Parameters
T
=
any
R
=
any
Hierarchy
Omit
<
JobJsonSandbox
,
"data"
|
"opts"
|
"returnvalue"
>
SandboxedJob
Index
Properties
attempts
Made
attempts
Started
data
debounce
Id?
deduplication
Id?
deferred
Failure?
delay?
failed
Reason
finished
On?
get
Children
Values
get
Dependencies
Count
get
Ignored
Children
Failures
id
log
move
To
Delayed
move
To
Wait
move
To
Waiting
Children
name
opts
parent?
parent
Key?
prefix
priority?
processed
By?
processed
On?
progress
queue
Name
queue
Qualified
Name
repeat
Job
Key?
return
Value
stacktrace?
stalled
Counter
timestamp
update
Data
update
Progress
Properties
attempts
Made
attemptsMade
:
number
attempts
Started
attemptsStarted
:
number
data
data
:
T
Optional
debounce
Id
debounceId
?:
string
Optional
deduplication
Id
deduplicationId
?:
string
Optional
deferred
Failure
deferredFailure
?:
string
Optional
delay
delay
?:
number
failed
Reason
failedReason
:
string
Optional
finished
On
finishedOn
?:
number
get
Children
Values
getChildrenValues
:
<
CT
=
any
>
()
=>
Promise
<
{
[
jobKey
:
string
]:
CT
}
>
get
Dependencies
Count
getDependenciesCount
:
(
opts
?:
{
failed
?:
boolean
;
ignored
?:
boolean
;
processed
?:
boolean
;
unprocessed
?:
boolean
;
}
,
)
=>
Promise
<
{
failed
?:
number
;
ignored
?:
number
;
processed
?:
number
;
unprocessed
?:
number
;
}
,
>
get
Ignored
Children
Failures
getIgnoredChildrenFailures
:
()
=>
Promise
<
{
[
jobKey
:
string
]:
string
}
>
id
id
:
string
log
log
:
(
row
:
string
)
=>
void
move
To
Delayed
moveToDelayed
:
(
timestamp
:
number
,
token
?:
string
)
=>
Promise
<
void
>
move
To
Wait
moveToWait
:
(
token
?:
string
)
=>
Promise
<
void
>
move
To
Waiting
Children
moveToWaitingChildren
:
(
token
?:
string
,
opts
?:
MoveToWaitingChildrenOpts
,
)
=>
Promise
<
boolean
>
name
name
:
string
opts
opts
:
JobsOptions
Optional
parent
parent
?:
ParentKeys
Optional
parent
Key
parentKey
?:
string
prefix
prefix
:
string
Optional
priority
priority
?:
number
Optional
processed
By
processedBy
?:
string
Optional
processed
On
processedOn
?:
number
progress
progress
:
JobProgress
queue
Name
queueName
:
string
queue
Qualified
Name
queueQualifiedName
:
string
Optional
repeat
Job
Key
repeatJobKey
?:
string
return
Value
returnValue
:
R
Optional
stacktrace
stacktrace
?:
string
stalled
Counter
stalledCounter
:
number
timestamp
timestamp
:
number
update
Data
updateData
:
(
data
:
T
)
=>
Promise
<
void
>
update
Progress
updateProgress
:
(
value
:
JobProgress
)
=>
Promise
<
void
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
attempts
Made
attempts
Started
data
debounce
Id
deduplication
Id
deferred
Failure
delay
failed
Reason
finished
On
get
Children
Values
get
Dependencies
Count
get
Ignored
Children
Failures
id
log
move
To
Delayed
move
To
Wait
move
To
Waiting
Children
name
opts
parent
parent
Key
prefix
priority
processed
By
processed
On
progress
queue
Name
queue
Qualified
Name
repeat
Job
Key
return
Value
stacktrace
stalled
Counter
timestamp
update
Data
update
Progress
bullmq - v6.0.3
Loading...
See
https://docs.bullmq.io/guide/workers/sandboxed-processors