@types/node-cron v3.0.11

Installation

npm install --save @types/node-cron

Summary

This package contains type definitions for node-cron (https://github.com/node-cron/node-cron).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-cron.

index.d.ts

// Type definitions for node-cron 3.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>,
//                 Richard Honor <https://github.com/RMHonor>
//                 Ata Berk YILMAZ <https://github.com/ataberkylmz>
//                 Alex Seidmann <https://github.com/aseidma>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import EventEmitter = require('events');

export function schedule(cronExpression: string, func: (now: Date) => void, options?: ScheduleOptions): ScheduledTask;

export function validate(cronExpression: string): boolean;

export function getTasks(): ScheduledTask[];

export interface ScheduledTask extends EventEmitter {
    start: () => this;
    stop: () => this;
}

export interface ScheduleOptions {
    /**
     * A boolean to set if the created task is scheduled.
     *
     * Defaults to `true`
     */
    scheduled?: boolean | undefined;
    /**
     * The timezone that is used for job scheduling
     */
    timezone?: string;
    /**
     * Specifies whether to recover missed executions instead of skipping them.
     *
     * Defaults to `false`
     */
    recoverMissedExecutions?: boolean;
}

Additional Details

• Last updated: Sun, 02 Jan 2022 18:01:29 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by morsic, burtek, Richard Honor, Ata Berk YILMAZ, and Alex Seidmann.