node-cron-expression
Version:
Declarative functional crontab expression builder
42 lines (41 loc) • 1.55 kB
TypeScript
import { HourExpression, MinuteExpression, MonthExpression } from './expression';
/**
* Every single minute or every X minute after current date time
*
* ```
* everyMinute(3); // *\/3 * * * *
* ```
*/
export declare const everyMinute: (minute?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | undefined) => MinuteExpression;
/**
* Every single hour or every X hours after current date time. Defaults
* to the first minute of that hour.
*
* ```
* everyHour(3); // 0 *\/3 * * *
* ```
*/
export declare const everyHour: (hour?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | undefined) => HourExpression;
/**
* Every single month or every X months after current date time. Defaults
* to the first minute, first hour and first day of the month.
*
* ```
* everyHour(3); // 0 *\/3 * * *
* ```
*/
export declare const everyMonth: (month?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | undefined) => MonthExpression;
/**
* Every X time point
*
* ```
* every(3).minutes(); // *\/3 * * *
* every(3).hours(); // 0 *\/3 * * *
* every(3).months(); // 0 0 1 *\/3 *
* ```
*/
export declare const every: (input: number) => {
minutes: () => MinuteExpression;
hours: () => HourExpression;
months: () => MonthExpression;
};