Class RunningCrons<Context, Name>

The return class from running cron jobs. Can be used to pause all crons, receive events, start specific crons, etc.

Type Parameters

Context
Name extends string

Hierarchy

ListenTarget<AllCronEvents>
- RunningCrons

Index

Constructors

Properties

context crons lastExecutionTimes log options pausedCrons timeouts

Methods

destroy pauseAll pauseCron resumeAll resumeCron setNextCron

Constructors

constructor

new RunningCrons<Context, Name extends string>(
    context: Context,
    crons: readonly Readonly<CronDefinition<Context, Name>>[],
    options?: Readonly<RunningCronsOptions>,
): RunningCrons<Context, Name>
Type Parameters
- Context
- Name extends string
Parameters
- context: Context
- crons: readonly Readonly<CronDefinition<Context, Name>>[]
- options: Readonly<RunningCronsOptions> = {}
Returns RunningCrons<Context, Name>
Overrides ListenTarget<AllCronEvents>.constructor
- Defined in src/running-crons.ts:88

Properties

`Readonly`context

context: Context

`Readonly`crons

crons: readonly Readonly<CronDefinition<Context, Name>>[]

`Protected` `Readonly`lastExecutionTimes

lastExecutionTimes: Partial<{ [CronName in string]: FullDate | undefined }> = {}

`Protected` `Readonly`log

log: LoggerLogs

`Readonly`options

options: Readonly<RunningCronsOptions> = {}

`Protected` `Readonly`pausedCrons

pausedCrons: { [key: string]: boolean } = {}

`Protected` `Readonly`timeouts

timeouts: { [key: string]: Readonly<Timeout> | undefined } = {}

Methods

destroy

destroy(): void
Clean up resources and stop all crons.

Returns void
Overrides ListenTarget.destroy
- Defined in src/running-crons.ts:282

pauseAll

pauseAll(): void
Pause all cron jobs.

Returns void
- Defined in src/running-crons.ts:275

pauseCron

pauseCron(name: Name): boolean
Pause a specific cron job.
Parameters
- name: Name
Returns boolean
false if no cron by the given name was found or if the cron was already paused.
- Defined in src/running-crons.ts:244

resumeAll

resumeAll(): void
Resume all paused cron jobs.

Returns void
- Defined in src/running-crons.ts:268

resumeCron

resumeCron(name: Name): boolean
Resume a specific cron job.
Parameters
- name: Name
Returns boolean
false if no cron by the given name was found or if the cron was already resumed.
- Defined in src/running-crons.ts:132

`Protected`setNextCron

setNextCron(
cron: Readonly<CronDefinition<Context, string>>,
immediate?: boolean,
): boolean
Set the next iteration of the given cron.
Parameters
- cron: Readonly<CronDefinition<Context, string>>
- Optionalimmediate: boolean
Returns boolean
- Defined in src/running-crons.ts:159