@sideloop/core
Preparing search index...
SideJobShape
Interface SideJobShape<T>
interface
SideJobShape
<
T
=
unknown
>
{
get
arguments
()
:
T
;
get
concurrencyDuration
()
:
null
|
number
;
get
concurrencyGroup
()
:
string
;
get
concurrencyKey
()
:
null
|
string
;
get
concurrencyLimit
()
:
null
|
number
;
get
executions
()
:
number
;
get
jobName
()
:
string
;
get
priority
()
:
number
;
get
queueName
()
:
string
;
get
scheduledAt
()
:
null
|
Date
;
deserialize
(
jobData
:
JobArguments
)
:
void
;
enqueue
()
:
Promise
<
Job
>
;
performNow
()
:
Promise
<
void
>
;
serialize
()
:
string
;
set
(
options
:
JobOptions
)
:
SideJobShape
<
T
>
;
}
Type Parameters
T
=
unknown
Index
Accessors
arguments
concurrency
Duration
concurrency
Group
concurrency
Key
concurrency
Limit
executions
job
Name
priority
queue
Name
scheduled
At
Methods
deserialize
enqueue
perform
Now
serialize
set
Accessors
arguments
get
arguments
()
:
T
Returns
T
concurrency
Duration
get
concurrencyDuration
()
:
null
|
number
Returns
null
|
number
concurrency
Group
get
concurrencyGroup
()
:
string
Returns
string
concurrency
Key
get
concurrencyKey
()
:
null
|
string
Returns
null
|
string
concurrency
Limit
get
concurrencyLimit
()
:
null
|
number
Returns
null
|
number
executions
get
executions
()
:
number
Returns
number
job
Name
get
jobName
()
:
string
Returns
string
priority
get
priority
()
:
number
Returns
number
queue
Name
get
queueName
()
:
string
Returns
string
scheduled
At
get
scheduledAt
()
:
null
|
Date
Returns
null
|
Date
Methods
deserialize
deserialize
(
jobData
:
JobArguments
)
:
void
Parameters
jobData
:
JobArguments
Returns
void
enqueue
enqueue
()
:
Promise
<
Job
>
Returns
Promise
<
Job
>
perform
Now
performNow
()
:
Promise
<
void
>
Returns
Promise
<
void
>
serialize
serialize
()
:
string
Returns
string
set
set
(
options
:
JobOptions
)
:
SideJobShape
<
T
>
Parameters
options
:
JobOptions
Returns
SideJobShape
<
T
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Accessors
arguments
concurrency
Duration
concurrency
Group
concurrency
Key
concurrency
Limit
executions
job
Name
priority
queue
Name
scheduled
At
Methods
deserialize
enqueue
perform
Now
serialize
set
@sideloop/core
Loading...