Properties
Optional cronJob
cronJob?: CronJob<null, null>
firstRun
firstRun: null | Date = null
Optional interval
interval?: number
Optional intervalId
intervalId?: Timeout
lastRun
lastRun: null | Date = null
Optional maxFails
maxFails?: number
Optional maxRetries
maxRetries?: number
Optional maxRuns
maxRuns?: number
nextRun
nextRun: null | Date = null
Optional onFail
onFail?: ((error) => void | Promise<void>)
Type declaration
- (error): void | Promise<void>
Returns void | Promise<void>
Optional onFinish
onFinish?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onPause
onPause?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onResume
onResume?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onRetry
onRetry?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onRun
onRun?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onStart
onStart?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
Optional onStop
onStop?: (() => void | Promise<void>)
Type declaration
- (): void | Promise<void>
Returns void | Promise<void>
paused
paused: boolean = false
retries
retries: number = 0
retryTimeout
retryTimeout: number
Optional schedule
schedule?: string
stopped
stopped: boolean = false
timeoutOnPause
timeoutOnPause: number
Static Readonly defaults
defaults: {
log: boolean;
maxFails: number;
maxRetries: number;
maxRuns: number;
once: boolean;
retryTimeout: number;
timeout: number;
timeoutOnPause: number;
} = ...
Type declaration
log: boolean
maxFails: number
maxRetries: number
maxRuns: number
once: boolean
retryTimeout: number
timeout: number
timeoutOnPause: number