Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 4.54 KB

README.md

File metadata and controls

116 lines (82 loc) · 4.54 KB
Raw

@jsbits/easter-day

Part of the JSBits suite.

License npm Version minified size
AppVeyor Test Travis Test coverage code quality maintainability

Calculates the local date of the Easter day for years up to 9999.

Install

For NodeJS and JS bundlers:

npm i @jsbits/easter-day
# or
yarn add @jsbits/easter-day

or load easterDay in the browser:

<script src="https://unpkg.com/@jsbits/easter-day/index.b.min.js"></script>

Targets

  • ES5 compatible browser
  • NodeJS v4.2 or later

easterDay(year) ⇒ Date

Calculates the local date of the Easter day –aka Pascha or Resurrection Sunday– for years between 100 and 9999 in the Gregorian calendar, based on Oudin's algorithm.

Easter always falls on a Sunday between March 22 and April 25, inclusive.

NOTE: The result for years less than 1583 could be inaccurate.

This is a good algorithm, but calculating the Easter is not an exact science or something consensuated, so expect discrepancies with older or future implementations.

Param Type Description
year number Year for the desired date, between 100 and 9999

Returns: Date - Local date instance for the Easter day

Since 1.1.3
Group: date
Author/Maintainer: aMarCruz
See: Paschalion at OrthodoxWiki

Example

import easterDay from '@jsbits/easter-day'

const easter = easterDay(2019)
console.log(easter.toDateString()) // ⇒ Sun Apr 21 2019

Imports

All the JSBits functions works in strict mode and are compatible with:

  • ES5 browsers, through the jQuery $.jsbits object or the global jsbits.
  • ESM Bundlers, like webpack and Rollup.
  • ES modules for modern browsers or NodeJS with the --experimental-modules flag.
  • CommonJS modules of NodeJS, jspm, and others.
  • Babel and TypeScript, through ES Module Interop.

Please see the Distribution Formats in the JSBits README to know about all the variants.

Support my Work

I'm a full-stack developer with more than 20 year of experience and I try to share most of my work for free and help others, but this takes a significant amount of time and effort so, if you like my work, please consider...

Of course, feedback, PRs, and stars are also welcome 🙃

Thanks for your support!

License

The MIT License.

© 2018-2019 Alberto Martínez – Readme powered by jscc and jsdoc-to-markdown