waratuman / rfc5545-rrule

RFC5545 RRule library for JavaScript

RFC5545 RRule

RFC5545 RRule library for JavaScript.

Installation

Using NPM:

npm install rfc5545-rrule

Using Yarn:

yarn add rfc5545-rrule

Usage

Node.js

let { RRule, Day } = require("rfc5545-rrule");

let rrule = RRule.fromString("RRULE:FREQ=YEARLY;INTERVAL=4;BYMONTH=11;BYDAY=TU;BYMONTHDAY=2,3,4,5,6,7,8");

console.log(rrule);
// RRule {
//     interval: 4,
//     weekStart: 1,
//     frequency: 'yearly',
//     byMonth: [ 10 ],
//     byDay: [ Day { value: 2, nth: undefined } ],
//     byMonthDay: [ 2, 3, 4, 5, 6, 7, 8 ]
// }

// A recurrence that repeats every Sunday of the week.
rrule = new RRule({ frequency: "weekly", byDay: [ new Day(0) ] });
rrule.toString(); // RRULE:FREQ=WEEKLY;BYDAY=SU

TypeScript

import { RRule } = from "rfc5545-rrule";

let rrule = RRule.fromString("RRULE:FREQ=YEARLY;INTERVAL=4;BYMONTH=11;BYDAY=TU;BYMONTHDAY=2,3,4,5,6,7,8");

License

ICS

Development

Compiling the grammar

npx nearleyc ./src/grammar.ne -o ./src/grammar.ts

Update ./src/grammar.ts to export ParserRules and ParserStart. Also, remove the wrapping function and export at the bottom of the file.

npm run compile

rfc5545-rrule's Issues

Wrong result from "RRule.fromString"

Tried an example and got a wrong result (check byYearDay in the result in the code below):

Text: every 3 years on the 1st, 100th and 240th day for 10 times
RRULE: RRULE:FREQ=YEARLY;INTERVAL=3;COUNT=10;BYYEARDAY=1,100,240

Source Code:

let { RRule, Day } = require('rfc5545-rrule');

let rrule = RRule.fromString(
  'RRULE:FREQ=YEARLY;INTERVAL=3;COUNT=10;BYYEARDAY=1,100,240'
);

console.log(rrule);
// RRule {
//  interval: 3,
//  bySecond: [],
//  byMinute: [],
//  byHour: [],
//  byDay: [],
//  byMonthDay: [],
//  byYearDay: [ 1, 10, 24 ], // TODO it should have been [1, 100, 240]
//  byWeekNumber: [],
//  byMonth: [],
//  bySetPosition: [],
//  weekStart: 1,
//  toJSON: [Function (anonymous)],
//  frequency: 'yearly',
//  count: 10
// }

Generating the RRULE using new RRule works fine

let newRRule = new RRule({
  frequency: 'yearly',
  interval: 3,
  byYearDay: [1, 100, 240],
  count: 10
});

console.log(newRRule.toString());
// RRULE:FREQ=YEARLY;COUNT=10;INTERVAL=3;BYYEARDAY=1,100,240

SyntaxError: Unexpected reserved word

Error on (function (exports, require, module, __filename, __dirname) { export * from ".

Could you please make a note that this library requires environment to support export keyword, Object.assign, and maybe other things out of ES5?