Options
All
  • Public
  • Public/Protected
  • All
Menu

Calendar interval parser which compiles recurrence definitions into executable schedule objects. Provides parsing of human-readable text expressions and a fluent builder API for defining recurring schedules. Compiled schedules can enumerate forward and backward occurrences, check validity, compute ranges, and drive timers.

Hierarchy

Index

Properties

Static activeDateHelper

activeDateHelper: typeof DateHelper = DateHelper

The DateHelper used by the time-period operations (val/start/end/next/prev) and by nextDate/prevDate while enumerating occurrences. Defaults to the static (local-time) DateHelper. Set to a timezone-aware DateHelperTZ (by CalendarCacheSingle) for the duration of a generation pass so recurring calendar intervals are computed directly in the intended timezone, with correct DST handling. Always restored in a finally, so the shared periods stay timezone agnostic and the compiled-schedule caches remain valid.

Static cachedCompiler

cachedCompiler: ((scheduleDefinition: ScheduleConstraint) => CompiledConstraint) | null = null

Cached compile function. Lazily created by createCompiler.

Methods

Static compile

  • Compile a parsed schedule definition into an executable schedule object. The returned CompiledSchedule provides next, prev, nextRange, prevRange, and isValid methods for enumerating occurrences.

    Parameters

    Returns CompiledSchedule

    Compiled schedule with enumeration methods

Static compileConstraint

Static convertTextTokenValue

  • convertTextTokenValue(text: string, tokenType: RegExp): any
  • Normalize a matched token's text into the value the schedule builder expects.

    internal

    Parameters

    • text: string

      Raw matched text (already lowercased)

    • tokenType: RegExp

      Which TEXT_TOKENTYPES regex matched

    Returns any

    Converted token value

Static createCompiledSchedule

Static createCompiler

Static createModifiers

  • Create modifier functions (after/before) used by the schedule compiler. Modifiers wrap a TimePeriod constraint to restrict it to a subset of its extent.

    Returns ModifierMap

    Map of modifier functions keyed by name (after, before) and short alias (a, b)

Static createRecurBuilder

  • Internal factory hook for the text parser to obtain a fresh ScheduleBuilder. External callers should use recur instead.

    internal

    Returns ScheduleBuilder

Static createTimePeriods

  • Build the TimePeriodMap, a long-name/short-alias view over the TimePeriodsMixin singletons.

    Returns TimePeriodMap

    Map of period objects keyed by name and alias (e.g. both year and Y map to the periodYear static)

Static modifierAfter

  • after N modifier which restricts constraint to values >= N.

    internal

    Parameters

    • constraint: TimePeriod

      Period to restrict

    • values: number[]

      [N] — threshold value

    Returns TimePeriod

    Restricted period

Static modifierBefore

  • before N modifier which restricts constraint to values < N.

    internal

    Parameters

    • constraint: TimePeriod

      Period to restrict

    • values: number[]

      [N] — threshold value (last entry used)

    Returns TimePeriod

    Restricted period

Static nextDate

  • nextDate(year: number, month?: number, dayOfMonth?: number, hours?: number, minutes?: number, seconds?: number): Date
  • Build a Date for the start of a period. Uses 1-based month. Omitted fields default to the start of the period (Jan 1, 00:00:00).

    Parameters

    • year: number

      Full year

    • Optional month: number
    • Optional dayOfMonth: number
    • Optional hours: number
    • Optional minutes: number
    • Optional seconds: number

    Returns Date

Static nextRollover

  • Roll forward to the next period if the current value is past or equal to value.

    Parameters

    • date: Date

      Current date

    • value: number

      Target constraint value

    • constraint: TimePeriod

      The constraint being resolved

    • period: TimePeriod

      The containing period to roll over

    Returns Date

Static parseText

  • Parse a human-readable text expression into a schedule definition. Recognized expressions include patterns like "every 5 minutes", "on Monday, Wednesday, and Friday at 9:00", "on the 1st and 15th day of the month", etc. If parsing fails, the returned definition will have error >= 0 indicating the character position where parsing stopped.

    Parameters

    • str: string

      Human-readable schedule expression

    Returns ScheduleDefinition

    Parsed definition with schedules, exceptions, and error fields

Static prevDate

  • prevDate(year: number, month?: number, dayOfMonth?: number, hours?: number, minutes?: number, seconds?: number): Date
  • Build a Date for the end of a period. Uses 1-based month. Omitted fields default to the end of the period (Dec 31, 23:59:59).

    Parameters

    • year: number

      Full year

    • Optional month: number
    • Optional dayOfMonth: number
    • Optional hours: number
    • Optional minutes: number
    • Optional seconds: number

    Returns Date

Static prevRollover

  • Roll backward to the previous period if the current value is at or past value.

    Parameters

    • date: Date

      Current date

    • value: number

      Target constraint value

    • constraint: TimePeriod

      The constraint being resolved

    • period: TimePeriod

      The containing period to roll over

    Returns Date

Static recur

  • recur(): any
  • Create a fluent recurrence builder for composing schedule definitions programmatically. Chain constraint methods (.on(), .every(), .after(), .before()) followed by a time-period method (.second(), .minute(), .hour(), .dayOfMonth(), .dayOfWeek(), .month(), .year(), etc.) to build up a definition.

    The returned builder can be passed directly as a recurrentStartDate or recurrentEndDate value on calendar intervals, or compiled via compile.

    Returns any

    Fluent builder with .schedules and .exceptions arrays

Object literals

Static Readonly TEXT_NAMES

TEXT_NAMES: object

Lowercase month/weekday/ordinal → numeric value. Used by the text parser.

see

CalendarIntervalParser.parseText

see

CalendarIntervalParser.convertTextTokenValue

internal

1st

1st: number = 1

2nd

2nd: number = 2

3rd

3rd: number = 3

4th

4th: number = 4

apr

apr: number = 4

aug

aug: number = 8

dec

dec: number = 12

feb

feb: number = 2

fir

fir: number = 1

for

for: number = 4

fri

fri: number = 6

jan

jan: number = 1

jul

jul: number = 7

jun

jun: number = 6

mar

mar: number = 3

may

may: number = 5

mon

mon: number = 2

nov

nov: number = 11

oct

oct: number = 10

sat

sat: number = 7

sec

sec: number = 2

sep

sep: number = 9

sun

sun: number = 1

thi

thi: number = 3

thu

thu: number = 5

tue

tue: number = 3

wed

wed: number = 4

Static Readonly TEXT_TOKENTYPES

TEXT_TOKENTYPES: object

Token regexes for the human-readable text parser.

see

CalendarIntervalParser.parseText

internal

after

after: RegExp = /^after\b/

also

also: RegExp = /(also)\b/

and

and: RegExp = /^(,|and\b)/

at

at: RegExp = /^(at|@)\b/

before

before: RegExp = /^before\b/

between

between: RegExp = /^between (the)?\b/

day

day: RegExp = /^(day(s)?( of the month)?)\b/

dayInstance

dayInstance: RegExp = /^day instance\b/

dayName

dayName: RegExp = /^((sun|mon|tue(s)?|wed(nes)?|thu(r(s)?)?|fri|sat(ur)?)(day)?)\b/

dayOfWeek

dayOfWeek: RegExp = /^day(s)? of the week\b/

dayOfYear

dayOfYear: RegExp = /^day(s)? of the year\b/

eof

eof: RegExp = /^$/

every

every: RegExp = /^every\b/

except

except: RegExp = /^(except\b)/

first

first: RegExp = /^(first)\b/

fullDate

fullDate: RegExp = /^(\d\d\d\d-\d\d-\d\d(t\d\d(:\d\d(:\d\d)?)?)?)\b/

hour

hour: RegExp = /^(h|hour(s)?)\b/

in

in: RegExp = /^in\b/

last

last: RegExp = /^last\b/

minute

minute: RegExp = /^(m|min(ute)?(s)?)\b/

month

month: RegExp = /^month(s)?\b/

monthName

monthName: RegExp = /^(jan(uary)?|feb(ruary)?|ma((r(ch)?)?|y)|apr(il)?|ju(ly|ne)|aug(ust)?|oct(ober)?|(sept|nov|dec)(ember)?)\b/

of

of: RegExp = /^of\b/

on

on: RegExp = /^on\b/

onthe

onthe: RegExp = /^on the\b/

rank

rank: RegExp = /^((\d\d\d\d)|([2-5]?1(st)?|[2-5]?2(nd)?|[2-5]?3(rd)?|(0|[1-5]?[4-9]|[1-5]0|1[1-3])(th)?))\b/

second

second: RegExp = /^(s|sec(ond)?(s)?)\b/

start

start: RegExp = /^(start(ing)? (at|on( the)?)?)\b/

through

through: RegExp = /(-|^(to|through)\b)/

time

time: RegExp = /^((([0]?[1-9]|1[0-2]):[0-5]\d(\s)?(am|pm))|(([0]?\d|1\d|2[0-3]):[0-5]\d))\b/

weekOfMonth

weekOfMonth: RegExp = /^week(s)? of the month\b/

weekOfYear

weekOfYear: RegExp = /^week(s)?( of the year)?\b/

weekday

weekday: RegExp = /^weekday\b/

weekend

weekend: RegExp = /^weekend\b/

year

year: RegExp = /^year(s)?\b/

yearIndex

yearIndex: RegExp = /^(\d\d\d\d)\b/

Static Readonly periodDay

periodDay: object

day (alias D) time period, day of month (1-31).

internal

name

name: string = "day"

range

range: number = 86400

end

  • Parameters

    Returns Date

extent

  • Parameters

    Returns number[]

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodDayOfWeek

periodDayOfWeek: object

dayOfWeek (aliases dw, d) time period, ISO-ish day of week (1=Sun … 7=Sat).

internal

name

name: string = "day of week"

range

range: number = 86400

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodDayOfWeekCount

periodDayOfWeekCount: object

dayOfWeekCount (alias dc) time period, 1-based n-th instance of the current weekday in the current month (e.g. the 2nd Tuesday). A value of 0 denotes "last occurrence".

internal

name

name: string = "day of week count"

range

range: number = 604800

val

  • Parameters

    Returns number

Static Readonly periodDayOfYear

periodDayOfYear: object

dayOfYear (alias dy) time period, 1-based day of year (1-366).

internal

name

name: string = "day of year"

range

range: number = 86400

end

  • Parameters

    Returns Date

extent

  • Parameters

    Returns number[]

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodFullDate

periodFullDate: object

fullDate (alias fd) time period. Used for anchoring rules like after 2022-01-01 to a specific date.

internal

name

name: string = "full date"

range

range: number = 1

Static Readonly periodHour

periodHour: object

hour (alias h) time period — hour of day (0-23).

internal

name

name: string = "hour"

range

range: number = 3600

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodMinute

periodMinute: object

minute (alias m) time period — minute of hour (0-59).

internal

name

name: string = "minute"

range

range: number = 60

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodMonth

periodMonth: object

month (alias M) time period — 1-based month of year (1-12).

internal

name

name: string = "month"

range

range: number = 2629740

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodSecond

periodSecond: object

second (alias s) time period — second of minute (0-59).

internal

name

name: string = "second"

range

range: number = 1

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodTime

periodTime: object

time (alias t) time period — seconds since midnight (0-86399). Used by rules like at 10:00.

internal

name

name: string = "time"

range

range: number = 1

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodWeekOfMonth

periodWeekOfMonth: object

weekOfMonth (alias wm) time period — 1-based week-of-month (week starts Sunday). Used for rules like on the 2nd week of the month.

internal

name

name: string = "week of month"

range

range: number = 604800

end

  • Parameters

    Returns Date

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Static Readonly periodWeekOfYear

periodWeekOfYear: object

weekOfYear (alias wy) time period. Week 1 is the week containing the first Thursday of the year.

internal

name

name: string = "week of year (ISO)"

range

range: number = 604800

end

  • Parameters

    Returns Date

start

  • Parameters

    Returns Date

Static Readonly periodYear

periodYear: object

year (alias Y) time period, calendar year 1970-2099.

internal

name

name: string = "year"

range

range: number = 31556900

end

  • Parameters

    Returns Date

extent

  • extent(): number[]
  • Returns number[]

isValid

  • Parameters

    Returns boolean

next

  • Parameters

    Returns 0 | Date

prev

  • Parameters

    Returns 0 | Date

start

  • Parameters

    Returns Date

val

  • Parameters

    Returns number

Generated using TypeDoc