nanakshahi
Version:
A JavaScript Library to get Nanakshahi Dates and Gurpurabs
11 lines (10 loc) • 469 B
TypeScript
import type { GurpurabName } from './types';
/**
* Returns all Gurpurabs that fall on a Gregorian date.
*
* @param gregorianDate - JavaScript Date object (default: current date).
* @returns Gurpurabs for the day with name fields in English and Punjabi.
* @throws {RangeError} If the date resolves to a Nanakshahi year before 535 NS.
* @example getGurpurabsForDate(new Date())
*/
export declare function getGurpurabsForDate(gregorianDate?: Date): GurpurabName[];