Skip to content
rrulenetPublic

About

Shared recurrence engine for parsing, querying, timezone-aware expansion, set composition, and text rendering.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

rrule.net

@rrulenet/core

Shared recurrence engine for parsing, querying, timezone-aware expansion, set composition, and text rendering.

rrule.net • Temporal API • @rrulenet ecosystem

@rrulenet/rrule · @rrulenet/recurrence · @rrulenet/core · @rrulenet/cli

npm version JSR version Coverage MIT License

@rrulenet/rrule: classic API · @rrulenet/recurrence: Temporal-first API · @rrulenet/core: engine · @rrulenet/cli: workflows

@rrulenet/core provides the shared recurrence engine for the @rrulenet ecosystem. Use it when building a recurrence adapter or working directly with engine sources. For application code, choose @rrulenet/rrule for the classic Date API or @rrulenet/recurrence for the Temporal-first API.

Install

npm install @rrulenet/core

Requires Node.js 20 or later when used with Node. The engine uses native Temporal where available and the included polyfill otherwise.

Public entry points

Import Purpose
@rrulenet/core Parsing and shared recurrence APIs
@rrulenet/core/engine RuleSource, ElapsedSource, DateSource and SetEngine
@rrulenet/core/rule Rule types and helpers
@rrulenet/core/options Rule options
@rrulenet/core/time Date and Temporal conversion helpers
@rrulenet/core/text Natural-language rendering

Temporal behavior

Calendar rules follow local calendar dates and clock values. Elapsed sources follow an exact anchor and fixed duration; explicit dates retain their instants. Calendar overlaps select the first passage, while spring gaps use the pre-transition offset. COUNT applies before explicit dates and exclusions.

Unbounded all() returns a finite preview. Use bounded queries, directional queries, or ordered iteration when you need more of the series. An error with code RECURRENCE_SEARCH_LIMIT means the query could not establish completeness; it does not prove that the schedule is empty.

See the engine reference for source contracts, selector validation and search behavior.

About

Shared recurrence engine for parsing, querying, timezone-aware expansion, set composition, and text rendering.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages