https://github.com/mamal72/iranian-calendar-events

Fetch Iranian calendar events (Jalali, Hijri and Gregorian) from time.ir website
https://github.com/mamal72/iranian-calendar-events

crawler events iranian jalali jalali-calendar persian

Last synced: 3 months ago
JSON representation

Fetch Iranian calendar events (Jalali, Hijri and Gregorian) from time.ir website

• Host: GitHub
• URL: https://github.com/mamal72/iranian-calendar-events
• Owner: mamal72
• License: mit
• Created: 2017-06-08T05:04:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-02T09:12:42.000Z (over 3 years ago)
• Last Synced: 2024-10-07T23:07:22.809Z (4 months ago)
• Topics: crawler, events, iranian, jalali, jalali-calendar, persian
• Language: JavaScript
• Size: 33.2 KB
• Stars: 31
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mamal72/iranian-calendar-events.svg?branch=master)](https://travis-ci.org/mamal72/iranian-calendar-events)

[![license](https://img.shields.io/github/license/mamal72/iranian-calendar-events.svg)](https://github.com/mamal72/iranian-calendar-events/blob/master/LICENSE)

# iranian-calendar-events

A simple package to fetch Iranian calendar events (Jalali, Hijri, Gregorian) from [time.ir](http://www.time.ir) website.

## Installation

```bash

npm i iranian-calendar-events

# or

yarn add iranian-calendar-events

```

## Usage

```js

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](https://github.com/mamal72/iranian-calendar-events/blob/master/LICENSE).