@raydeck/interval-manager
v2.0.1
Published
<a name="readmemd"></a>
Downloads
11
Readme
Manage Complex Time Intervals
interval-manager
Usage
npx @raydeck/interval-manager [options]Get the next scheduled time based on the provided interval
Options
- --hour <
hour...> Set hour on which this should fire - --minute <
minute...> Set minute on which this should fire - --second <
second...> Set second on which this should file - --timezone <
timezone> Timezone for this (default:America/Chicago) - --reference-date <
isoDate> ISO-8601 representation of the reference (default:2021-04-06T12:26:39.909Z) - --starting-date <
isoDate> ISO-8601 representation of the date the interval had started (default:2021-04-06T12:26:39.909Z) - --ending-date <
isoDate> ISO-8601 representation of the date the interval had ended (default:2021-04-06T12:26:39.909Z) - --dayOfMonth <
daynumber...> Day of the month to run 1-31 (note that not all months have >28 days) - --dayOfWeek <
dayofweek...> Day of the week to run, either a number from 0-6 one of sunday, monday, tuesday, wednesday, thursday, friday, saturday - --monthOfYear <
month...> Month of the year to run in, either a number from 1-12 one of january, february, march, april, may, june, july, august, september, october, november, december - --orderInMonth <
weekNumber...> Ordinal of the day of week within month to run, e.g. 2 and setting day of week to friday is second friday of the month - --dayOfYear <
dayNumber...> Ordinal day of the year e.g. on ther 120th day of the year is 120 - --weekInterval <
weeks> Number of weeks between each event - --dayInterval <
days> Number of days between each event - --maxDates <
limit> Number of dates to return (default:2) - --verbose Use human-readable version of the date as output (default is ISO-8601)
@raydeck/interval-manager - v2.0.1
@raydeck/interval-manager - v2.0.1
Table of contents
Interfaces
Variables
Functions
Variables
DAYINTERVALS
• Const DAYINTERVALS: number[]
Valid day intervals 1-1000
Defined in: index.ts:524
DAYSOFWEEK
• Const DAYSOFWEEK: object
Valid days of the week by name (valid values 0-6)
Type declaration:
Name | Type |
:------ | :------ |
FRIDAY | number |
MONDAY | number |
SATURDAY | number |
SUNDAY | number |
THURSDAY | number |
TUESDAY | number |
WEDNESDAY | number |
Defined in: index.ts:482
DAYSOFYEAR
• Const DAYSOFYEAR: number[]
Valid days of the year 1-366
Defined in: index.ts:520
HOURS
• Const HOURS: number[]
Valid hours of the day 0-23
Defined in: index.ts:514
MINUTES
• Const MINUTES: number[]
Valid minutes 0-59
Defined in: index.ts:516
MONTHSOFYEAR
• Const MONTHSOFYEAR: object
Months of the year by name (valid values 1-12)
Type declaration:
Name | Type |
:------ | :------ |
APRIL | number |
AUGUST | number |
DECEMBER | number |
FEBRUARY | number |
JANUARY | number |
JULY | number |
JUNE | number |
MARCH | number |
MAY | number |
NOVEMBER | number |
OCTOBER | number |
SEPTEMBER | number |
Defined in: index.ts:494
ORDERINMONTH
• Const ORDERINMONTH: number[]
Valid order in a month for a weekday (e.g. 3rd Friday). Note: LASTDAY of -1 when you want the last of that weeekday (e.g. last Monday of the month)
Defined in: index.ts:512
SECONDS
• Const SECONDS: number[]
Valid seconds 0-59
Defined in: index.ts:518
WEEKINTERVALS
• Const WEEKINTERVALS: number[]
Valid week intervals 1-100
Defined in: index.ts:528
Functions
getNextDate
▸ getNextDate(schedule: IntervalSchedule, nowDate?: Date): Date
Get the next date/time after the specified reference date
Parameters:
Name | Type | Description |
:------ | :------ | :------ |
schedule | IntervalSchedule | IntervalSchedule that defines this interval pattern |
nowDate | Date | Date the result must be after. Defaults to now |
Returns: Date
Date with the next time this schedule should fire
Defined in: index.ts:10
isValidTimeZone
▸ isValidTimeZone(tz: string): boolean
Determines whether a given string is a valid/known timezone identifier
Parameters:
Name | Type | Description |
:------ | :------ | :------ |
tz | string | Source string (e.g. America/New_York) |
Returns: boolean
True if the string is a valid time zone, false if not
Defined in: index.ts:412
validateSchedule
▸ validateSchedule(schedule: IntervalSchedule): void
Assert-style validator of whether a given IntervalSchedule contains valid values. Throws if not
Parameters:
Name | Type | Description |
:------ | :------ | :------ |
schedule | IntervalSchedule | IntervalSchedule to test |
Returns: void
Defined in: index.ts:249
@raydeck/interval-manager - v2.0.1 / IntervalSchedule
Interface: IntervalSchedule
Interface for defining a schedule for delayed intervals
Table of contents
Properties
- dayInterval
- daysOfMonth
- daysOfWeek
- daysOfYear
- endingOn
- hours
- minutes
- monthsOfYear
- orderInMonth
- seconds
- startingOn
- timezone
- weekInterval
Properties
dayInterval
• Optional dayInterval: number
Days to wait between runs, starting from the startsOn date. This can run multiple times per day if hour, minute or second are set with multiple values.Not compatible with weekInterval, monthsOfYear, daysOfYear
Defined in: index.ts:243
daysOfMonth
• Optional daysOfMonth: number[]
Days of the month on which this should fire. Note that not all months have >28 days. Not compatible with dayInterval, weekInterval, daysOfYear
Defined in: index.ts:233
daysOfWeek
• Optional daysOfWeek: number[]
Days of the week (specified as 0-6, where 0 is Sunday and 6 is Saturday). Not compatible with dayInterval, weekInterval, daysOfYear, daysOfMonth
Defined in: index.ts:235
daysOfYear
• Optional daysOfYear: number[]
Days of the year on which this should fire. E.g. to run on the 88th day of the year, specify [88]. Note that not all months have >28 days. Not compatible with dayInterval, weekInterval, daysOfWeek
Defined in: index.ts:237
endingOn
• Optional endingOn: Date
Ending date for this schedule
Defined in: index.ts:219
hours
• hours: number[]
Hours (in local time) on which this schedule should fire
Defined in: index.ts:223
minutes
• Optional minutes: number[]
Minutes on which this should fire (e.g. [0, 30] for on the hour and half-hour) (default [0])
Defined in: index.ts:227
monthsOfYear
• Optional monthsOfYear: number[]
Months of the year on which this should fire. Not compatible with dayInterval, weekInterval, daysOfYear
Defined in: index.ts:231
orderInMonth
• Optional orderInMonth: number[]
Order of the weekday to fire. For example, to run on the first friday, use {orderInMonth: [1], daysOfWeek:[5]}. Note that using this requires specifying daysOfWeek. Not compatibile with dayInterval, weekInterval, daysOfMonth, daysOfYear
Defined in: index.ts:241
seconds
• Optional seconds: number[]
Seconds on which this should file (default [0])
Defined in: index.ts:229
startingOn
• Optional startingOn: Date
Starting date for this schedule (matters for dayInterval and weekInterval)
Defined in: index.ts:215
timezone
• timezone: string
Time zone to define local time rule (e.g. daylight savings)
Defined in: index.ts:211
weekInterval
• Optional weekInterval: number
Weeks to wait between runs, starting from the startsOn date. This can run multiple times per day or on multiple weekdays based on daysOfWeek. Not compatible with dayInterval, monthsOfYear, daysOfYear
Defined in: index.ts:239