@sideloop/core
Preparing search index...
JobConstructor
Interface JobConstructor<T>
interface
JobConstructor
<
T
=
unknown
>
{
new
JobConstructor
(
args
:
T
)
:
SideJobShape
<
T
>
;
"[JOB_IDENTIFIER]"
:
true
;
get
concurrencyDuration
()
:
null
|
number
;
get
concurrencyGroup
()
:
undefined
|
ConcurrencyKey
<
T
>
;
get
concurrencyKey
()
:
null
|
ConcurrencyKey
<
T
>
;
get
concurrencyLimit
()
:
null
|
number
;
get
jobName
()
:
string
;
get
recurring
()
:
|
undefined
|
RecurringTaskOptions
<
T
>
|
RecurringTaskOptions
<
T
>
[]
;
performAllLater
(
argsList
:
T
[]
)
:
Promise
<
void
>
;
performLater
(
args
:
T
)
:
Promise
<
SideJobShape
<
T
>
>
;
set
(
options
:
JobOptions
)
:
ConfiguredJobShape
<
T
>
;
}
Type Parameters
T
=
unknown
Index
Constructors
constructor
Properties
[
JOB_
IDENTIFIER]
Accessors
concurrency
Duration
concurrency
Group
concurrency
Key
concurrency
Limit
job
Name
recurring
Methods
perform
All
Later
perform
Later
set
Constructors
constructor
new
JobConstructor
(
args
:
T
)
:
SideJobShape
<
T
>
Parameters
args
:
T
Returns
SideJobShape
<
T
>
Properties
[
JOB_
IDENTIFIER]
"[JOB_IDENTIFIER]"
:
true
Accessors
concurrency
Duration
get
concurrencyDuration
()
:
null
|
number
Returns
null
|
number
concurrency
Group
get
concurrencyGroup
()
:
undefined
|
ConcurrencyKey
<
T
>
Returns
undefined
|
ConcurrencyKey
<
T
>
concurrency
Key
get
concurrencyKey
()
:
null
|
ConcurrencyKey
<
T
>
Returns
null
|
ConcurrencyKey
<
T
>
concurrency
Limit
get
concurrencyLimit
()
:
null
|
number
Returns
null
|
number
job
Name
get
jobName
()
:
string
Returns
string
recurring
get
recurring
()
:
undefined
|
RecurringTaskOptions
<
T
>
|
RecurringTaskOptions
<
T
>
[]
Returns
undefined
|
RecurringTaskOptions
<
T
>
|
RecurringTaskOptions
<
T
>
[]
Methods
perform
All
Later
performAllLater
(
argsList
:
T
[]
)
:
Promise
<
void
>
Parameters
argsList
:
T
[]
Returns
Promise
<
void
>
perform
Later
performLater
(
args
:
T
)
:
Promise
<
SideJobShape
<
T
>
>
Parameters
args
:
T
Returns
Promise
<
SideJobShape
<
T
>
>
set
set
(
options
:
JobOptions
)
:
ConfiguredJobShape
<
T
>
Parameters
options
:
JobOptions
Returns
ConfiguredJobShape
<
T
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
[
JOB_
IDENTIFIER]
Accessors
concurrency
Duration
concurrency
Group
concurrency
Key
concurrency
Limit
job
Name
recurring
Methods
perform
All
Later
perform
Later
set
@sideloop/core
Loading...