UNPKG

2.27 kBTypeScriptView Raw
1import { CronTime } from './time';
2import { CronCallback, CronContext, CronJobParams, CronOnCompleteCallback, CronOnCompleteCommand, WithOnComplete } from './types/cron.types';
3export declare class CronJob<OC extends CronOnCompleteCommand | null = null, C = null> {
4 cronTime: CronTime;
5 running: boolean;
6 unrefTimeout: boolean;
7 lastExecution: Date | null;
8 runOnce: boolean;
9 context: CronContext<C>;
10 onComplete?: WithOnComplete<OC> extends true ? CronOnCompleteCallback : undefined;
11 waitForCompletion: boolean;
12 errorHandler?: CronJobParams<OC, C>['errorHandler'];
13 private _isCallbackRunning;
14 private _timeout?;
15 private _callbacks;
16 get isCallbackRunning(): boolean;
17 constructor(cronTime: CronJobParams<OC, C>['cronTime'], onTick: CronJobParams<OC, C>['onTick'], onComplete?: CronJobParams<OC, C>['onComplete'], start?: CronJobParams<OC, C>['start'], timeZone?: CronJobParams<OC, C>['timeZone'], context?: CronJobParams<OC, C>['context'], runOnInit?: CronJobParams<OC, C>['runOnInit'], utcOffset?: null, unrefTimeout?: CronJobParams<OC, C>['unrefTimeout'], waitForCompletion?: CronJobParams<OC, C>['waitForCompletion'], errorHandler?: CronJobParams<OC, C>['errorHandler']);
18 constructor(cronTime: CronJobParams<OC, C>['cronTime'], onTick: CronJobParams<OC, C>['onTick'], onComplete?: CronJobParams<OC, C>['onComplete'], start?: CronJobParams<OC, C>['start'], timeZone?: null, context?: CronJobParams<OC, C>['context'], runOnInit?: CronJobParams<OC, C>['runOnInit'], utcOffset?: CronJobParams<OC, C>['utcOffset'], unrefTimeout?: CronJobParams<OC, C>['unrefTimeout'], waitForCompletion?: CronJobParams<OC, C>['waitForCompletion'], errorHandler?: CronJobParams<OC, C>['errorHandler']);
19 static from<OC extends CronOnCompleteCommand | null = null, C = null>(params: CronJobParams<OC, C>): CronJob<OC, C>;
20 private _fnWrap;
21 addCallback(callback: CronCallback<C, WithOnComplete<OC>>): void;
22 setTime(time: CronTime): void;
23 nextDate(): import("luxon").DateTime<boolean>;
24 fireOnTick(): Promise<void>;
25 nextDates(i?: number): import("luxon").DateTime<boolean>[];
26 start(): void;
27 lastDate(): Date | null;
28 private _executeOnComplete;
29 private _waitForJobCompletion;
30 stop(): void;
31}