JobBuilder
Defined in: packages/client/src/jobs/job-builder.ts:35
What every builder (CommandBuilder, EventBuilder, …) produces: a build() method tagged with its kind.
Implements
Constructors
Constructor
new JobBuilder(): JobBuilder;Returns
JobBuilder
Properties
[BRICK]
readonly [BRICK]: "job";Defined in: packages/client/src/jobs/job-builder.ts:36
Implementation of
Methods
build()
build(): JobDefinition;Defined in: packages/client/src/jobs/job-builder.ts:97
Returns
Implementation of
setCron()
setCron(expression, options?): this;Defined in: packages/client/src/jobs/job-builder.ts:56
Parameters
expression
string
Cron expression
options?
timezone is an IANA name
timezone?
string
Returns
this
setHandler()
setHandler(handler): this;Defined in: packages/client/src/jobs/job-builder.ts:92
Parameters
handler
(client, job) => unknown
Receives the client and the run info
Returns
this
setInterval()
setInterval(seconds): this;Defined in: packages/client/src/jobs/job-builder.ts:62
Parameters
seconds
number
Delay between two runs
Returns
this
setName()
setName(name): this;Defined in: packages/client/src/jobs/job-builder.ts:47
Parameters
name
string
Lowercase, letters digits _ and -, 1 to 32 characters
Returns
this
setOverlap()
setOverlap(policy): this;Defined in: packages/client/src/jobs/job-builder.ts:74
Parameters
policy
skip or queue a run while the previous one is still going
Returns
this
setRequiresConnection()
setRequiresConnection(requiresConnection): this;Defined in: packages/client/src/jobs/job-builder.ts:86
Parameters
requiresConnection
boolean
Skip scheduled runs while the radio is disconnected
Returns
this
setRunOnStart()
setRunOnStart(runOnStart?): this;Defined in: packages/client/src/jobs/job-builder.ts:68
Parameters
runOnStart?
boolean = true
Run once when the client is ready. Default true
Returns
this
setTimeout()
setTimeout(seconds): this;Defined in: packages/client/src/jobs/job-builder.ts:80
Parameters
seconds
number
Abort the run after this delay. 0 disables
Returns
this