Preparing search index...
The search index is not available
bullmq - v5.17.0
bullmq
v2
SandboxedJob
Interface SandboxedJob<T, R>
See
https://docs.bullmq.io/guide/workers/sandboxed-processors
interface
SandboxedJob
<
T
,
R
>
{
attemptsMade
:
number
;
data
:
T
;
failedReason
:
string
;
finishedOn
?:
number
;
id
:
string
;
log
:
(
(
row
)
=>
void
)
;
name
:
string
;
opts
:
JobsOptions
;
parent
?:
ParentKeys
;
parentKey
?:
string
;
processedOn
?:
number
;
repeatJobKey
?:
string
;
returnValue
:
R
;
returnvalue
:
string
;
stacktrace
:
string
;
timestamp
:
number
;
update
:
(
(
data
)
=>
Promise
<
void
>
)
;
updateProgress
:
(
(
value
)
=>
Promise
<
void
>
)
;
}
Type Parameters
T
=
any
R
=
any
Hierarchy
Omit
<
JobJson
,
"data"
|
"opts"
|
"progress"
|
"returnValue"
>
SandboxedJob
Index
Properties
attempts
Made
data
failed
Reason
finished
On?
id
log
name
opts
parent?
parent
Key?
processed
On?
repeat
Job
Key?
return
Value
returnvalue
stacktrace
timestamp
update
update
Progress
Properties
attempts
Made
attempts
Made
:
number
data
data
:
T
failed
Reason
failed
Reason
:
string
Optional
finished
On
finished
On
?:
number
id
id
:
string
log
log
:
(
(
row
)
=>
void
)
Type declaration
(
row
)
:
void
Parameters
row
:
any
Returns
void
name
name
:
string
opts
opts
:
JobsOptions
Optional
parent
parent
?:
ParentKeys
Optional
parent
Key
parent
Key
?:
string
Optional
processed
On
processed
On
?:
number
Optional
repeat
Job
Key
repeat
Job
Key
?:
string
return
Value
return
Value
:
R
returnvalue
returnvalue
:
string
stacktrace
stacktrace
:
string
timestamp
timestamp
:
number
update
update
:
(
(
data
)
=>
Promise
<
void
>
)
Type declaration
(
data
)
:
Promise
<
void
>
Parameters
data
:
any
Returns
Promise
<
void
>
update
Progress
update
Progress
:
(
(
value
)
=>
Promise
<
void
>
)
Type declaration
(
value
)
:
Promise
<
void
>
Parameters
value
:
number
|
object
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
attempts
Made
data
failed
Reason
finished
On
id
log
name
opts
parent
parent
Key
processed
On
repeat
Job
Key
return
Value
returnvalue
stacktrace
timestamp
update
update
Progress
bullmq - v5.17.0
v5
v4
v3
v2
v1
Generated using
TypeDoc
See
https://docs.bullmq.io/guide/workers/sandboxed-processors