rrule-rust is a library for handling recurrence rules, powered by Rust's high-performance rrule crate.
npm i rrule-rust
If you need a browser-compatible version with WASM support, install it from the alpha channel:
npm i rrule-rust@alpha
The WebAssembly (WASM) version is currently available on the
alphachannel, as it relies on an alpha release of napi.rs. Once napi.rs v3 is officially released, WASM support will be included in the main (latest) release channel.
For more usage examples and advanced scenarios, see the tests directory in the repository.
import { RRule, RRuleSet, Frequency, DateTime } from 'rrule-rust';
const rrule = new RRule({
frequency: Frequency.Daily,
count: 5,
});
const set = new RRuleSet({
dtstart: DateTime.create(1997, 9, 2, 9, 0, 0, false),
tzid: 'US/Eastern',
rrules: [rrule],
});
const dates = set.all(); // [ DateTime, DateTime, DateTime, DateTime, DateTime ]
const asString = set.toString(); // DTSTART;TZID=US/Eastern:19970902T090000\nFREQ=DAILY;COUNT=5;BYHOUR=9;BYMINUTE=0;BYSECOND=0 Host: MacBook Pro, 14-inch, 2023
OS: macOS 14.4.1 (23E224)
Processor: Apple M3 Pro
Memory: 36 GB LPDDR5
| rrule | rrule-rust | ||
|---|---|---|---|
| UTC TZ | 15 904 ops/s | 108 538 ops/s | ~6x faster |
| Other TZ | 260 ops/s | 106 034 ops/s | ~400x faster |
You can run benchmarks using npm run benchmark.
rrule-rust is MIT licensed.