UNPKG

1.78 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 private _timeout?;
12 private _callbacks;
13 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']);
14 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']);
15 static from<OC extends CronOnCompleteCommand | null = null, C = null>(params: CronJobParams<OC, C>): CronJob<OC, C>;
16 private _fnWrap;
17 addCallback(callback: CronCallback<C, WithOnComplete<OC>>): void;
18 setTime(time: CronTime): void;
19 nextDate(): import("luxon").DateTime;
20 fireOnTick(): void;
21 nextDates(i?: number): import("luxon").DateTime[];
22 start(): void;
23 lastDate(): Date | null;
24 stop(): void;
25}