nanakshahi

nanakshahi-js

A JavaScript Library to get Nanakshahi Dates and Gurpurabs

Contents

• Usage
• API
  • getGregorianFromLunarDate(year, year, tithi, [paksh]) ⇒ Object
  • getHolidaysForDay(gregorianDate) ⇒ Array
  • getHolidaysForMonth(month) ⇒ Object
  • getMovableHoliday(holiday, [year]) ⇒ Object
  • getNanakshahiDate(gregorianDate) ⇒ Object
  • getPanchang(date, [isJulian]) ⇒ Object
  • getTithi(date) ⇒ Object
• Contributing

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.getHolidaysForDay( date )
n.getHolidaysForMonth( 1 )
n.getMovableHoliday( 'gurunanak' )
n.getTithi( date )
n.getPanchang( date )
n.getGregorianFromLunarDate( 1723, 10, 7 )

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?

API

getGregorianFromLunarDate(year, year, tithi, [paksh]) ⇒ 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
year	number		Bikrami Month
tithi	number		Bikrami Tithi
[paksh]	boolean	false	Lunar Paksh. Default is Sudi, true for Vadi.

Example

getGregorianFromLunarDate( 1723, 10, 7 )

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) ⇒ 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

Example

getHolidaysForMonth( 1 )

getMovableHoliday(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

getMovableHoliday( 'gurunanak' )

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() )

getPanchang(date, [isJulian]) ⇒ Object

Returns given date to the corresponding date in the Panchang

Returns: Object - Panchang (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

getPanchang( new Date() )

getTithi(date) ⇒ Object

Get Tithi and other Moon/Lunar Info

Returns: Object - Tithi and Moon Info

Param	Type	Description
date	Object	JavaScript Date() Object

Example

getTithi( new Date() )

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.
• Run tests with npm test and ensure they all pass. Testing is done with the mocha testing framework.
• Create a pull request with the changes.