Class RRule

constructor

• new RRule(rule: string | RRuleOptions, defaultTimezone?: string): RRule

  Constructs a new RRule instance from an RFC 5545 string or options object.

  Parameters

  • rule: string | RRuleOptions

    RFC 5545 string (e.g. "FREQ=DAILY;INTERVAL=2;BYHOUR=10") or RRuleOptions.

  • OptionaldefaultTimezone: string

    Optional default IANA timezone if not defined in string/options.

  Returns RRule

Readonlyoptions

Static ReadonlyDAILY

Static ReadonlyFR

Static ReadonlyHOURLY

Static ReadonlyMINUTELY

Static ReadonlyMO

Static ReadonlyMONTHLY

Static ReadonlySA

Static ReadonlySECONDLY

Static ReadonlySU

Static ReadonlyTH

Static ReadonlyTU

Static ReadonlyWE

Static ReadonlyWEEKLY

Static ReadonlyYEARLY

after

• after(afterDate?: Date): Date | null

  Calculates the next occurrence strictly after the given date.

  Parameters

  • afterDate: Date = ...

    Timestamp anchor after which the next occurrence must occur (defaults to now).

  Returns Date | null

  Next execution Date, or null if series is exhausted.

StaticparseString

• parseString(str: string): RRuleOptions

  Parses an RFC 5545 string into structured RRuleOptions.

  Parameters

  • str: string

    Standard RFC 5545 string.

  Returns RRuleOptions

  Structured options object.