Home

Awesome

Build Status license

iranian-calendar-events

A simple package to fetch Iranian calendar events (Jalali, Hijri, Gregorian) from time.ir website.

Installation

npm i iranian-calendar-events
# or
yarn add iranian-calendar-events

Usage

import ice from 'iranian-calendar-events';

(async () => {
  const yearEvents = await ice({ year: 1396 }); // all events of the year
  const monthEvents = await ice({ year: 1396, month: 12 }); // all events of the month
  const dayEvents = await ice({ year: 1396, month: 12, day: 15 }); // all events of a day
  const dayEventsInAllMonths = await ice({ year: 1396, day: 15 }); // all events of a day number in all months
  // That's it! You can use them now!
})();

Ideas or Issues

Create an issue and describe it. I'll check it ASAP!

Contribution

You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. :heart:

Remember to write a few tests for your code before sending pull requests.

License

Licensed under the MIT License.