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.getGurpurabsForDay( date ) n.getGurpurabsForMonth( 1 ) n.findMovableGurpurab( 'gurunanak' )
Additionally, the package is available for web use via unpkg CDN.
Or via jsDelivr
This library is based on the Nanakshahi calendar passed by Sri Akal Takht Sahib in 2003 CE.
All Gurpurabs and historical dates are reckoned with their solar dates. An exception to this are the movable lunar dates which are to be reckoned using the Bikrami calendar until further Panthic consensus.
The Nanakshahi functions will only calculate dates after Nanakshahi adoption in 2003 CE. Any dates before March 14, 2003 CE (535 NS) will return with an
Out of Range error.
In this library, the Date object has been given in the local time of the client. This ensures that the Gregorian date calculated by the functions is correct regardless of timezone.
getDateFromNanakshahi(year, month, date)
Converts Nanakshahi Date into the Gregorian Calendar
Object - Gregorian Date + Nanakshahi Date in English and Punjabi
||Nanakshahi Month, 1-12|
getDateFromNanakshahi( 550, 10, 23 )
Returns all Gurpurabs for a Date
Array - Gurpurabs for the day with Date and name in English and Punjabi
getGurpurabsForDay( new Date() )
Returns all Gurpurabs for a Nanakshahi Month
Object - Gurpurabs for the month with Date and name in English and Punjabi
||Nanakshahi Month, 1-12|
||Nanakshahi Year. Default is current Nanakshahi Year.|
getGurpurabsForMonth( 1 )
Converts given Gregorian Date to the corresponding date in the Nanakshahi Calendar
Object - Nanakshahi Date in English and Punjabi
getNanakshahiDate( new Date() )
Returns Gregorian Date of Movable Gurpurab
Object - Gurpurab Date with Name in English and Punjabi
||Gregorian year, default is current year.|
findMovableGurpurab( 'gurunanak' )
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. Spent countless hours verifying the calculations done by me.
E. M. Reingold and N. Dershowitz for their Calendrical Calculations book and their calendar functions, which serve as the base for the movable Gurpurab calculations done in this library.
My father, Jasjit Singh, whose curiosity in the Nanakshahi and Bikrami calendar systems inspired me to find answers to his technical questions.
To get started, clone this repo and run
npm install inside this directory.
ESLint plugin works out of the box), so you can receive linter suggestions as you type.
When writing commit messages, please follow the Conventional Commits specification.
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 should not be edited, instead apply modifications to
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
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, as per version 3 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.