Installation & Setup

The nepali date library is distributed as a lightweight npm package compatible with modern JavaScript runtimes including Node.js, Bun, and Deno. It provides native TypeScript type definitions out of the box with zero runtime dependencies, making setup fast across all standard package managers.

Package InstallationCopy Anchor Link

pnpm add nepali-date-library

Import SyntaxCopy Anchor Link

The package supports both ECMAScript Modules (ESM) and CommonJS (CJS) natively.

ECMAScript Modules (TypeScript / Modern JS)Copy Anchor Link

import { NepaliDate, ADtoBS, BStoAD } from "nepali-date-library";

// or default import
import NepaliDate from "nepali-date-library";

CommonJSCopy Anchor Link

const { NepaliDate, ADtoBS, BStoAD } = require("nepali-date-library");

// or default require
const NepaliDate = require("nepali-date-library");

TypeScript ConfigurationCopy Anchor Link

nepali-date-library is written in TypeScript and ships with bundled type definitions (.d.ts). No additional @types/ packages are required.

Recommended tsconfig.json compiler options:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
    "esModuleInterop": true
  }
}

Zero DependenciesCopy Anchor Link

The package has 0 runtime external dependencies. It contains all astronomical calendar mappings, formatting tokens, and date arithmetic routines internally, guaranteeing small bundle size and zero transitive vulnerability risks.