{"_id":"@askbuddie/bikram-sambat","name":"@askbuddie/bikram-sambat","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@askbuddie/bikram-sambat","version":"1.0.0","description":"A JS library for Nepali dates. Developed by Ask Buddie, this NPM library simplifies working with the Nepali calendar in JavaScript. It offers inuitive API methods making Nepali date handling effortless.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest","test:watch":"jest --watchAll","build":"tsc","lint":"eslint src --ext .ts","format":"prettier --write src/**/*.ts"},"repository":{"type":"git","url":"git+https://github.com/askbuddie/bikram-sambat.git"},"keywords":["nepali-date-picker","bikram-sambat","nepali-date","nepali-date-js"],"author":{"name":"Ask Buddie","email":"info@askbuddie.com"},"license":"MIT","bugs":{"url":"https://github.com/askbuddie/bikram-sambat/issues"},"homepage":"https://github.com/askbuddie/bikram-sambat#readme","devDependencies":{"@types/jest":"^29.5.3","@typescript-eslint/eslint-plugin":"^6.3.0","@typescript-eslint/parser":"^6.3.0","eslint":"^8.47.0","jest":"^29.6.2","prettier":"^3.0.1","ts-jest":"^29.1.1","typescript":"^5.1.6"},"_id":"@askbuddie/bikram-sambat@1.0.0","gitHead":"ece93b39f3813556c34fcb46195b74b5a5e14e78","_nodeVersion":"21.3.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-KyoRsPaGhH20KAreMO8vfajFVUxw5q8XYYVWtTLsO8+DJIwKU/d8rPcOaSQTo9Orrs/tbkRRd09UbcqYH+/iYg==","shasum":"82f0e8864e1f8927219a3ea0a0e572377eeea104","tarball":"https://registry.npmjs.org/@askbuddie/bikram-sambat/-/bikram-sambat-1.0.0.tgz","fileCount":100,"unpackedSize":189300,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDynebd3d6aJA8VGs+YG8mm2wHzpePu/f/vUftciG3PvAiEAuOIMi9VtSTU8qXbQF7NBiKPLe22cGpkpOs8S2jwyaTI="}]},"_npmUser":{"name":"ashiishme","email":"iamashiishy@gmail.com"},"directories":{},"maintainers":[{"name":"ashiishme","email":"iamashiishy@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bikram-sambat_1.0.0_1701731144774_0.36405830050606314"},"_hasShrinkwrap":false}},"time":{"created":"2023-12-04T23:05:44.673Z","1.0.0":"2023-12-04T23:05:45.065Z","modified":"2023-12-04T23:05:45.359Z"},"maintainers":[{"name":"ashiishme","email":"iamashiishy@gmail.com"}],"description":"A JS library for Nepali dates. Developed by Ask Buddie, this NPM library simplifies working with the Nepali calendar in JavaScript. It offers inuitive API methods making Nepali date handling effortless.","homepage":"https://github.com/askbuddie/bikram-sambat#readme","keywords":["nepali-date-picker","bikram-sambat","nepali-date","nepali-date-js"],"repository":{"type":"git","url":"git+https://github.com/askbuddie/bikram-sambat.git"},"author":{"name":"Ask Buddie","email":"info@askbuddie.com"},"bugs":{"url":"https://github.com/askbuddie/bikram-sambat/issues"},"license":"MIT","readme":"![GitHub repo size](https://img.shields.io/github/repo-size/askbuddie/bikram-sambat?style=flat-square)\n![GitHub top language](https://img.shields.io/github/languages/top/askbuddie/bikram-sambat?color=orange&style=flat-square)\n![GitHub last commit](https://img.shields.io/github/last-commit/askbuddie/bikram-sambat?color=success&style=flat-square)\n![GitHub license](https://img.shields.io/badge/license-GPL%20%2B%20CE-FFFF00?style=flat-square)\n[![GitHub Stars](https://img.shields.io/github/stars/askbuddie/bikram-sambat?label=GitHub%20stars&style=social)](https://github.com/askbuddie/bikram-sambat/stargazers/)\n\n## Introduction\n\nThe `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.\n\n## Installation\n\nTo use `bikram-sambat` library in your project, install it using `npm` or `yarn`:\n\n```bash\nnpm i @askbuddie/bikram-sambat\n```\n\n```bash\nyarn add @askbuddie/bikram-sambat\n```\n\n## Getting Started\n\nHere's a quick guide to get started with the `BikramSambat` class:\n\n### Import the Class\n\n```javascript\nimport BikramSambat from '@askbuddie/bikram-sambat'\n```\n\n### Initialize a Date\n\nYou can create a `BikramSambat` instance using different initialization methods:\n\n```javascript\nconst date1 = new BikramSambat('2080-05-15') // Initialize with a date string\nconst date2 = new BikramSambat() // Initialize with the current date\n```\n\n## Manipulating Dates\n\n### Get Components\n\nRetrieve individual date components:\n\n```javascript\nconst year = date1.getYear() // 2080\nconst month = date1.getMonth() // 5\nconst day = date1.getDay() // 15\n```\n\n### Set Components\n\nUpdate date components:\n\n```javascript\ndate1.setYear(2079)\ndate1.setMonth(6)\ndate1.setDay(20)\n```\n\n### Formatting\n\nFormat dates as strings:\n\n```javascript\nconst formattedDate = date1.format('YYYY-MM-DD') // \"2080-05-15\"\nconst dateString = date1.toString() // \"2080-05-15\"\n```\n\n## Navigation and Comparison\n\nNavigate through dates and perform comparisons:\n\n```javascript\nconst prevYear = date1.getPreviousYear() // 2079\nconst nextYear = date1.getNextYear() // 2081\n\nconst isSameMonth = date1.isSameMonth(date2) // true\nconst isAfter = date1.isAfter(date2) // true\n```\n\n## Conversion and Retrieval\n\nConvert dates between the Bikram Sambat and Gregorian calendars:\n\n```javascript\nconst gregorianDate = date1.toAD() // JavaScript Date object\nconst bsDate = BikramSambat.fromAD(gregorianDate)\n```\n\nRetrieve relative dates:\n\n```javascript\nconst prevDay = date1.getPreviousDay()\nconst weekStart = date1.getWeekStartDate()\n```\n\n## Full Documentation\n\nFor a complete list of methods and their usage, please refer to the [API Documentation]()\n","readmeFilename":"README.md"}