mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
29 lines
846 B
TypeScript
29 lines
846 B
TypeScript
// Type definitions for node-cron 2.0
|
|
// Project: https://github.com/node-cron/node-cron, https://github.com/merencia/node-cron
|
|
// Definitions by: morsic <https://github.com/maximelkin>,
|
|
// burtek <https://github.com/burtek>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
export function schedule(cronExpression: string, func: () => void, options?: ScheduleOptions): ScheduledTask;
|
|
|
|
export function validate(cronExpression: string): boolean;
|
|
|
|
export interface ScheduledTask {
|
|
start: () => this;
|
|
stop: () => this;
|
|
destroy: () => void;
|
|
}
|
|
|
|
export interface ScheduleOptions {
|
|
/**
|
|
* A boolean to set if the created task is scheduled.
|
|
*
|
|
* Defaults to `true`
|
|
*/
|
|
scheduled?: boolean;
|
|
/**
|
|
* The timezone that is used for job scheduling
|
|
*/
|
|
timezone?: string;
|
|
}
|