npm

Does your artifact manager get in the way? Join us on Oct. 8 at 10am PT, to discuss how npm can help.Sign up »

nanakshahi

5.1.2 • Public • Published

nanakshahi-js

A JavaScript Library to get Nanakshahi Dates and Gurpurabs

npm Travis (.org) GitHub license GitHub issues GitHub pull requests jsdelivr

Contents

Usage

Install the library via NPM:

npm install nanakshahi

The library can be imported into Node as below:

const n = require('nanakshahi')
 
const date = new Date()
 
n.getNanakshahiDate( date )
n.getDateFromNanakshahi( 550, 10, 23 )
n.getHolidaysForDay( date )
n.getHolidaysForMonth( 1 )
n.getTithi( date )
n.findBikramiDate( date )
n.findDateFromTithi( 1723, 10, 7 )
n.findMovableHoliday( 'gurunanak' )

Additionally, the package is available for web use via unpkg CDN.

<script src="https://unpkg.com/nanakshahi"></script>

Or via jsDelivr

<script src="https://cdn.jsdelivr.net/npm/nanakshahi/dist/index.min.js"></script>

Want a demo?
Try on RunKit

Polyfill

While the library does run on most modern browsers, it does not work on IE11.

The library requires Math.sign and Array.prototype.includes. These can be added with the Polyfill below to add partial IE11 support:

<script crossorigin="anonymous" src="https://polyfill.io/v3/polyfill.min.js?features=Math.sign%2CArray.prototype.includes"></script>

The functions findBikramiDate() and findDateFromTithi() both use Date.prototype.toLocaleString(), with the Asia/Kolkata IANA timezone, which isn't supported in IE11.

API

getDateFromNanakshahi(year, month, date) ⇒ Object

Converts Nanakshahi Date into the Gregorian Calendar

Returns: Object - Gregorian Date

Param Type Description
year number Nanakshahi Year
month number Nanakshahi Month, 1-12
date number Nanakshahi Day

Example

getDateFromNanakshahi( 550, 10, 23 )

getHolidaysForDay([gregorianDate]) ⇒ Array

Returns all Gurpurabs and Holidays for a Date

Returns: Array - Holidays for the day with Date and name in English and Punjabi

Param Type Description
[gregorianDate] Object JavaScript Date() Object

Example

getHolidaysForDay( new Date() )

getHolidaysForMonth(month, [year]) ⇒ Object

Returns all Gurpurabs and Holidays for a Nanakshahi Month

Returns: Object - Holidays for the month with Date and name in English and Punjabi

Param Type Description
month number Nanakshahi Month, 1-12
[year] number Nanakshahi Year, Default is Current year

Example

getHolidaysForMonth( 1 )

getNanakshahiDate(gregorianDate) ⇒ Object

Converts given Gregorian Date to the corresponding date in the Nanakshahi Calendar

Returns: Object - Nanakshahi Date in English and Punjabi

Param Type Description
gregorianDate Object JavaScript Date() Object

Example

getNanakshahiDate( new Date() )

getTithi([gregorianDate]) ⇒ Object

Get Tithi and other Moon/Lunar Info

Returns: Object - Tithi and Moon Info

Param Type Description
[gregorianDate] Object JavaScript Date() Object, defaults to current Date.

Example

getTithi( new Date() )

findBikramiDate(date, [isJulian]) ⇒ Object

Returns given date to the corresponding date in the Bikrami Calendar

Returns: Object - Bikrami (Includes Lunar and Solar Date)

Param Type Default Description
date Object JavaScript Date() Object
[isJulian] boolean false Set to true if entered date is in Julian Calendar

Example

findBikramiDate( new Date() )

findDateFromTithi(year, month, date, [paksh], [leapMonth], [leapDay]) ⇒ Object

Converts Bikrami Lunar Date into the Gregorian Calendar (Accuracy of plus or minus 1 day)

Returns: Object - Gregorian Date

Param Type Default Description
year number Bikrami Year
month number Bikrami Month
date number Bikrami Tithi
[paksh] boolean false Lunar Paksh. Default is Sudi, true for Vadi.
[leapMonth] boolean false Set to true if the month is Adhika Month (Mal Maas)
[leapDay] boolean false Set to true if the lunar day spans more than 1 solar day

Example

findDateFromTithi( 1723, 10, 7 )

findMovableHoliday(holiday, [year]) ⇒ Object

Returns Gregorian Date of Movable Holiday Movable Holidays List:

  • gurunanak Parkash Guru Nanak Dev Ji
  • bandishhorr Bandi Shhorr Divas / Diwali
  • holla Holla Mahalla
  • kabeer Birthday Bhagat Kabeer Ji
  • ravidaas Birthday Bhagat Ravidaas Ji
  • naamdev Birthday Bhagat Naamdev Ji

Returns: Object - Holiday Date with Name in English and Punjabi

Param Type Description
holiday string Holiday which date will be calculated.
[year] number Gregorian year, default is current year.

Example

findMovableHoliday( 'gurunanak' )

Acknowledgements

I want to thank:

  • Guru Sahib, who inspires us into Sikhi.

  • Pal Singh Purewal, who explained various concepts in the Bikrami and Nanakshahi Calendars to me and answered my various technical and historical questions.

  • E. M. Reingold and N. Dershowitz for their Calendrical Calculations book and Calendrica program code, which serves as the base for this library.

  • My father, Jasjit Singh, whose curiosity in the Nanakshahi and Bikrami calendar systems inspired me find answers to his technical questions.

Contributing

We're happy to accept suggestions and pull requests!

To get started, clone this repo and run npm install inside this directory.

This repository follows the Airbnb's Javascript Style Guide, with a few minor modifications. Notably, spaces should be included inside parentheses and brackets (weird, right!). An ESLint file is provided, and your code will automatically be checked on-commit for style. It is recommended to install an ESLint plugin for your editor (VS Code's ESLint plugin works out of the box), so you can receive linter suggestions as you type.

When writing commit messages, please follow the seven rules. Markdown and HTML JSDoc documentation is generated automatically, on commit, however if you'd like to preview any changes to documentation, npm run build-docs will update README.md. README.md should not be edited, instead apply modifications to README.hbs.

The general workflow for contributing:

  • Fork/create a new branch.
  • Write or update existing tests with expected results
  • Implement functions/changes
  • Add JSDoc function documentation and examples.
  • Create a pull request with the changes.

install

npm i nanakshahi

Downloadsweekly downloads

40

version

5.1.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability