Skip to main content

Class: TimeoutJobDefinition

A class representing a timeout job definition.

Extends​

Constructors​

Constructor​

new TimeoutJobDefinition(name, timeout, execute, initiallyDisabled?): TimeoutJobDefinition

Parameters​

name​

string

timeout​

number

execute​

() => Promise<void>

initiallyDisabled?​

boolean

Returns​

TimeoutJobDefinition

Overrides​

JobDefinition.constructor

Properties​

initiallyDisabled​

readonly initiallyDisabled: boolean = false

Inherited from​

JobDefinition.initiallyDisabled

lastExecutionTime?​

protected optional lastExecutionTime?: Date

Inherited from​

JobDefinition.lastExecutionTime

name​

readonly name: string

Inherited from​

JobDefinition.name

trigger​

protected readonly trigger: JobTrigger

Overrides​

JobDefinition.trigger

type​

readonly type: JobType = JobType.Timeout

Overrides​

JobDefinition.type

Methods​

changeTrigger()​

protected changeTrigger(trigger): void

Parameters​

trigger​

JobTrigger

Returns​

void

Inherited from​

JobDefinition.changeTrigger

execute()​

execute(): Promise<void>

Executes the job.

Returns​

Promise<void>

A promise resolving when the job has been executed.

Inherited from​

JobDefinition.execute

getLastExecutionTime()​

getLastExecutionTime(): Date | undefined

Gets the last execution time of the job.

Returns​

Date | undefined

The last execution time, or undefined if the job has not been executed yet.

Inherited from​

JobDefinition.getLastExecutionTime

getNextExecutionTime()​

getNextExecutionTime(): Date | undefined

Gets the next execution time of the job.

Returns​

Date | undefined

The next execution time, or undefined if the job has no more executions.

Inherited from​

JobDefinition.getNextExecutionTime

updateTimeout()​

updateTimeout(timeout): void

Updates the timeout for the job.

Parameters​

timeout​

number

The new timeout.

Returns​

void

fromMetadata()​

static fromMetadata(metadata, execute): JobDefinition

Creates a job definition from metadata.

Parameters​

metadata​

JobMetadata

The metadata for the job.

execute​

() => Promise<void>

The function to execute when the job runs.

Returns​

JobDefinition

The created job definition.

Inherited from​

JobDefinition.fromMetadata