Giter Club home page Giter Club logo

bikram-sambat's Introduction

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

bikram-sambat's People

Contributors

aabishkaryal avatar ashiishme avatar asujan205 avatar blackkspydo avatar dependabot[bot] avatar roshandalami avatar sandeshad100 avatar thebishalniroula avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

bikram-sambat's Issues

Implement `isSameMonth`, `isSameYear`, isSameWeek` & `isSameDay` methods

for nonstatic method isSameMonth, isSameYear, isSameWeek & isSameDay all they take single argument of type instance of BikramSambat and compare it to own instance (this) an return boolean value,

for static method they take two arguments of instance BikramSambat and return boolean value

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.