Skip to main content

Variable: Patterns

const Patterns: object;

Type declaration​

EVERY_10_HOURS​

EVERY_10_HOURS: EVERY_10_HOURS = '0 0-23/10 * * *';

EVERY_10_MINUTES​

EVERY_10_MINUTES: EVERY_10_MINUTES = '0 */10 * * * *';

EVERY_10_SECONDS​

EVERY_10_SECONDS: EVERY_10_SECONDS = '*/10 * * * * *';

EVERY_11_HOURS​

EVERY_11_HOURS: EVERY_11_HOURS = '0 0-23/11 * * *';

EVERY_12_HOURS​

EVERY_12_HOURS: EVERY_12_HOURS = '0 0-23/12 * * *';

EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT​

EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = '0 0 1 * *';

EVERY_1ST_DAY_OF_MONTH_AT_NOON​

EVERY_1ST_DAY_OF_MONTH_AT_NOON: EVERY_1ST_DAY_OF_MONTH_AT_NOON = '0 12 1 * *';

EVERY_2_HOURS​

EVERY_2_HOURS: EVERY_2_HOURS = '0 0-23/2 * * *';

EVERY_2ND_HOUR​

EVERY_2ND_HOUR: EVERY_2ND_HOUR = '0 */2 * * *';

EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM​

EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM: EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = '0 1-23/2 * * *';

EVERY_2ND_MONTH​

EVERY_2ND_MONTH: EVERY_2ND_MONTH = '0 0 1 */2 *';

EVERY_3_HOURS​

EVERY_3_HOURS: EVERY_3_HOURS = '0 0-23/3 * * *';

EVERY_30_MINUTES​

EVERY_30_MINUTES: EVERY_30_MINUTES = '0 */30 * * * *';

EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM​

EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM: EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = '0 */30 10-19 * * *';

EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM​

EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM: EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = '0 */30 9-17 * * *';

EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM​

EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM: EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = '0 */30 9-18 * * *';

EVERY_30_SECONDS​

EVERY_30_SECONDS: EVERY_30_SECONDS = '*/30 * * * * *';

EVERY_4_HOURS​

EVERY_4_HOURS: EVERY_4_HOURS = '0 0-23/4 * * *';

EVERY_5_HOURS​

EVERY_5_HOURS: EVERY_5_HOURS = '0 0-23/5 * * *';

EVERY_5_MINUTES​

EVERY_5_MINUTES: EVERY_5_MINUTES = '0 */5 * * * *';

EVERY_5_SECONDS​

EVERY_5_SECONDS: EVERY_5_SECONDS = '*/5 * * * * *';

EVERY_6_HOURS​

EVERY_6_HOURS: EVERY_6_HOURS = '0 0-23/6 * * *';

EVERY_6_MONTHS​

EVERY_6_MONTHS: EVERY_6_MONTHS = '0 0 1 */6 *';

EVERY_7_HOURS​

EVERY_7_HOURS: EVERY_7_HOURS = '0 0-23/7 * * *';

EVERY_8_HOURS​

EVERY_8_HOURS: EVERY_8_HOURS = '0 0-23/8 * * *';

EVERY_9_HOURS​

EVERY_9_HOURS: EVERY_9_HOURS = '0 0-23/9 * * *';

EVERY_DAY_AT_10AM​

EVERY_DAY_AT_10AM: EVERY_DAY_AT_10AM = '0 10 * * *';

EVERY_DAY_AT_10PM​

EVERY_DAY_AT_10PM: EVERY_DAY_AT_10PM = '0 22 * * *';

EVERY_DAY_AT_11AM​

EVERY_DAY_AT_11AM: EVERY_DAY_AT_11AM = '0 11 * * *';

EVERY_DAY_AT_11PM​

EVERY_DAY_AT_11PM: EVERY_DAY_AT_11PM = '0 23 * * *';

EVERY_DAY_AT_1AM​

EVERY_DAY_AT_1AM: EVERY_DAY_AT_1AM = '0 01 * * *';

EVERY_DAY_AT_1PM​

EVERY_DAY_AT_1PM: EVERY_DAY_AT_1PM = '0 13 * * *';

EVERY_DAY_AT_2AM​

EVERY_DAY_AT_2AM: EVERY_DAY_AT_2AM = '0 02 * * *';

EVERY_DAY_AT_2PM​

EVERY_DAY_AT_2PM: EVERY_DAY_AT_2PM = '0 14 * * *';

EVERY_DAY_AT_3AM​

EVERY_DAY_AT_3AM: EVERY_DAY_AT_3AM = '0 03 * * *';

EVERY_DAY_AT_3PM​

EVERY_DAY_AT_3PM: EVERY_DAY_AT_3PM = '0 15 * * *';

EVERY_DAY_AT_4AM​

EVERY_DAY_AT_4AM: EVERY_DAY_AT_4AM = '0 04 * * *';

EVERY_DAY_AT_4PM​

EVERY_DAY_AT_4PM: EVERY_DAY_AT_4PM = '0 16 * * *';

EVERY_DAY_AT_5AM​

EVERY_DAY_AT_5AM: EVERY_DAY_AT_5AM = '0 05 * * *';

EVERY_DAY_AT_5PM​

EVERY_DAY_AT_5PM: EVERY_DAY_AT_5PM = '0 17 * * *';

EVERY_DAY_AT_6AM​

EVERY_DAY_AT_6AM: EVERY_DAY_AT_6AM = '0 06 * * *';

EVERY_DAY_AT_6PM​

EVERY_DAY_AT_6PM: EVERY_DAY_AT_6PM = '0 18 * * *';

EVERY_DAY_AT_7AM​

EVERY_DAY_AT_7AM: EVERY_DAY_AT_7AM = '0 07 * * *';

EVERY_DAY_AT_7PM​

EVERY_DAY_AT_7PM: EVERY_DAY_AT_7PM = '0 19 * * *';

EVERY_DAY_AT_8AM​

EVERY_DAY_AT_8AM: EVERY_DAY_AT_8AM = '0 08 * * *';

EVERY_DAY_AT_8PM​

EVERY_DAY_AT_8PM: EVERY_DAY_AT_8PM = '0 20 * * *';

EVERY_DAY_AT_9AM​

EVERY_DAY_AT_9AM: EVERY_DAY_AT_9AM = '0 09 * * *';

EVERY_DAY_AT_9PM​

EVERY_DAY_AT_9PM: EVERY_DAY_AT_9PM = '0 21 * * *';

EVERY_DAY_AT_MIDNIGHT​

EVERY_DAY_AT_MIDNIGHT: EVERY_DAY_AT_MIDNIGHT = '0 0 * * *';

EVERY_DAY_AT_NOON​

EVERY_DAY_AT_NOON: EVERY_DAY_AT_NOON = '0 12 * * *';

EVERY_HOUR​

EVERY_HOUR: EVERY_HOUR = '0 0-23/1 * * *';

EVERY_MINUTE​

EVERY_MINUTE: EVERY_MINUTE = '*/1 * * * *';

EVERY_QUARTER​

EVERY_QUARTER: EVERY_QUARTER = '0 0 1 */3 *';

EVERY_SECOND​

EVERY_SECOND: EVERY_SECOND = '* * * * * *';

EVERY_WEEK​

EVERY_WEEK: EVERY_WEEK = '0 0 * * 0';

EVERY_WEEKDAY​

EVERY_WEEKDAY: EVERY_WEEKDAY = '0 0 * * 1-5';

EVERY_WEEKEND​

EVERY_WEEKEND: EVERY_WEEKEND = '0 0 * * 6,0';

EVERY_YEAR​

EVERY_YEAR: EVERY_YEAR = '0 0 1 1 *';

FRIDAY​

FRIDAY: FRIDAY = 5;

MONDAY​

MONDAY: MONDAY = 1;

SATURDAY​

SATURDAY: SATURDAY = 6;

SUNDAY​

SUNDAY: SUNDAY = 0;

THURSDAY​

THURSDAY: THURSDAY = 4;

TUESDAY​

TUESDAY: TUESDAY = 2;

WEDNESAY​

WEDNESAY: WEDNESAY = 3;

daily()​

Run the task every day at 00:00 Alias: EVERY_DAY_AT_MIDNIGHT

Returns​

ConstantExpressions

everyDayAt()​

Run the task every day at HH:MM

Parameters​

ParameterTypeDefault valueDescription
time?string'00:00'The time in 'HH:mm' format (24-hour clock).

Returns​

string

everyHours()​

Run the task every H hours

Parameters​

ParameterTypeDefault valueDescription
hoursnumber1

Returns​

string

everyHoursAt()​

Run the task every H hours at M minutes

Parameters​

ParameterTypeDefault valueDescription
hoursnumberundefined
minutesnumber0

Returns​

string

everyMinute()​

Run the task every minute Alias: EVERY_MINUTE

Returns​

ConstantExpressions

everyMinutes()​

Run the task every M minutes

Parameters​

ParameterTypeDefault valueDescription
minutesnumber1

Returns​

string

everyQuarter()​

Run the task every quarter (3 months) Alias: EVERY_QUARTER

Returns​

ConstantExpressions

everySecond()​

Run the task every second Alias: EVERY_SECOND

Returns​

ConstantExpressions

everySenconds()​

Run the task every S seconds

Parameters​

ParameterTypeDefault valueDescription
secondsnumber1

Returns​

string

everyWeekday()​

Run the task every day from monday to friday at 00:00 Alias: EVERY_WEEKDAY

Returns​

ConstantExpressions

everyWeekdayAt()​

Run the task every day from monday to friday at given time

Parameters​

ParameterTypeDefault valueDescription
time?string'00:00'The time in 'HH:mm' format (24-hour clock).

Returns​

string

everyWeekend()​

Run the task on saturday and sunday at 00:00 Alias: EVERY_WEEKDAY

Returns​

ConstantExpressions

everyWeekendAt()​

Run the task on saturday and sunday at given time

Parameters​

ParameterTypeDefault valueDescription
time?string'00:00'The time in 'HH:mm' format (24-hour clock).

Returns​

string

everyWeekOn()​

Run the task at a specific time on a given day of the week.

Parameters​

ParameterTypeDefault valueDescription
daynumberundefinedThe day of the week (0 for Sunday, 1 for Monday, ..., 6 for Saturday).
time?string'00:00'The time in 'HH:mm' format (24-hour clock).

Returns​

string

hourly()​

Run the task every hour Alias: EVERY_HOUR

Returns​

ConstantExpressions

monthly()​

Run the task every first day of month at 00:00 Alias: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT

Returns​

ConstantExpressions

weekly()​

Run the task every week on monday at 00:00 Alias: EVERY_WEEK

Returns​

ConstantExpressions

yearly()​

Run the task on the first day of every year at 00:00 Alias: EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT

Returns​

ConstantExpressions