nanakshahi
Version:
A JavaScript Library to get Nanakshahi Dates and Gurpurabs
21 lines (20 loc) • 861 B
TypeScript
import type { MovableGurpurab, MovableGurpurabKey } from './types';
/**
* Returns Gregorian date info for a movable Gurpurab between 2003 CE and 2100 CE.
*
* Supported keys:
* - `gurunanak` - Parkash Guru Nanak Dev Ji
* - `bandichhorr` - Bandi Chhorr Divas
* - `holla` - Holla Mahalla
* - `kabeer` - Birthday Bhagat Kabeer Ji
* - `ravidaas` - Birthday Bhagat Ravidaas Ji
* - `naamdev` - Birthday Bhagat Naamdev Ji
*
* @param gurpurab - Movable Gurpurab key.
* @param year - Gregorian year (default: current year, range: 2003...2100).
* @returns Gurpurab date and localized name fields.
* @throws {TypeError} If year is not an integer.
* @throws {RangeError} If year is outside 2003...2100.
* @example findMovableGurpurab('gurunanak')
*/
export declare function findMovableGurpurab(gurpurab: MovableGurpurabKey, year?: number): MovableGurpurab;