Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 2.74 KB

README.md

File metadata and controls

103 lines (69 loc) · 2.74 KB

GitHub repo size GitHub top language GitHub last commit GitHub license GitHub Stars

Introduction

The BikramSambat library is designed to simplify date manipulation within the Bikram Sambat (Nepali) calendar system. This documentation provides a brief overview of key features and usage examples for the class, intended to facilitate its integration into your projects.

Installation

To use bikram-sambat library in your project, install it using npm or yarn:

npm i @askbuddie/bikram-sambat
yarn add @askbuddie/bikram-sambat

Getting Started

Here's a quick guide to get started with the BikramSambat class:

Import the Class

import BikramSambat from '@askbuddie/bikram-sambat'

Initialize a Date

You can create a BikramSambat instance using different initialization methods:

const date1 = new BikramSambat('2080-05-15') // Initialize with a date string
const date2 = new BikramSambat() // Initialize with the current date

Manipulating Dates

Get Components

Retrieve individual date components:

const year = date1.getYear() // 2080
const month = date1.getMonth() // 5
const day = date1.getDay() // 15

Set Components

Update date components:

date1.setYear(2079)
date1.setMonth(6)
date1.setDay(20)

Formatting

Format dates as strings:

const formattedDate = date1.format('YYYY-MM-DD') // "2080-05-15"
const dateString = date1.toString() // "2080-05-15"

Navigation and Comparison

Navigate through dates and perform comparisons:

const prevYear = date1.getPreviousYear() // 2079
const nextYear = date1.getNextYear() // 2081

const isSameMonth = date1.isSameMonth(date2) // true
const isAfter = date1.isAfter(date2) // true

Conversion and Retrieval

Convert dates between the Bikram Sambat and Gregorian calendars:

const gregorianDate = date1.toAD() // JavaScript Date object
const bsDate = BikramSambat.fromAD(gregorianDate)

Retrieve relative dates:

const prevDay = date1.getPreviousDay()
const weekStart = date1.getWeekStartDate()

Full Documentation

For a complete list of methods and their usage, please refer to the API Documentation