pascua
Version:
Get Easter date for any given year
59 lines (35 loc) • 1.46 kB
Markdown
# Pascua 🙏
[](https://badge.fury.io/js/pascua)
Get Easter date for any given year using the ["Meeus/Jones/butcher" algorithm](https://en.wikipedia.org/wiki/Computus).
Easter is traditionally celebrated on the first Sunday after the [Paschal full moon](https://en.wikipedia.org/wiki/Ecclesiastical_full_moon).
## Installation
To install as a dependency:
```
npm install pascua
```
## Usage
`pascua` exports a single function that takes an optional `integer` between 1583 and 4099 for the year.
```js
import pascua from "pascua";
// Easter date for the current year
const easter = pascua();
// Easter date for 1984
const easter1984 = pascua(1984);
```
The function will return an object with the following properties:
| Property | Description |
| ------------ | --------------------------------------- |
| `year` | Year |
| `month` | Month |
| `day` | Day |
| `toString()` | Returns a formatted string `YYYY-MM-DD` |
## TypeScript
Type definitions files are included.
## Contributing
Contributions, issues and feature requests are welcome!
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgements
[date-easter](https://github.com/commenthol/date-easter/blob/master/index.js).
## License
[MIT](LICENSE)