Options
All
  • Public
  • Public/Protected
  • All
Menu

node-cron-expression

Index

Type aliases

DayOfTheMonth

DayOfTheMonth: 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

DayOfTheWeek

DayOfTheWeek: 0 | 1 | 2 | 3 | 4 | 5 | 6

DayOfTheWeekLiteral

DayOfTheWeekLiteral: "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday"

Hour

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

Minute

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

Month

Month: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

MonthLiteral

MonthLiteral: "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"

Functions

Const atHour

  • Set to run in a specific hour. Defaults to the first minute of that hour

    atHour(3); // 0 3 * * *
    

    Parameters

    Returns HourExpression

Const atMinute

between

  • between<T>(startExpression: T, endExpression: T): Expression
  • Provide two time points of the same type to create a range

    between(atMinute(2), atMinute(20)); // 2-20 * * * *
    

    Type parameters

    Parameters

    • startExpression: T
    • endExpression: T

    Returns Expression

combine

Const every

  • every(input: number): { hours: any; minutes: any; months: any }

Const everyHour

  • Every single hour or every X hours after current date time. Defaults to the first minute of that hour.

    everyHour(3); // 0 *\/3 * * *
    

    Parameters

    • Optional hour: Hour

    Returns HourExpression

Const everyMinute

Const everyMonth

  • 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 * * *
    

    Parameters

    Returns MonthExpression

Const inMonth

Const onDayOfTheMonth

Const onDayOfTheWeek

Object literals

Const map

map: object

April

April: number = 4

August

August: number = 8

December

December: number = 12

February

February: number = 2

Friday

Friday: number = 5

January

January: number = 1

July

July: number = 7

June

June: number = 6

March

March: number = 3

May

May: number = 5

Monday

Monday: number = 1

November

November: number = 11

October

October: number = 10

Saturday

Saturday: number = 6

September

September: number = 9

Sunday

Sunday: number = 0

Thursday

Thursday: number = 4

Tuesday

Tuesday: number = 2

Wednesday

Wednesday: number = 3

Generated using TypeDoc