https://github.com/nainemom/idate
Iranian Date constractor for Javascript, Just like native Javascript Date.
https://github.com/nainemom/idate
Last synced: 2 months ago
JSON representation
Iranian Date constractor for Javascript, Just like native Javascript Date.
- Host: GitHub
- URL: https://github.com/nainemom/idate
- Owner: nainemom
- Created: 2018-02-16T16:58:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T16:27:09.000Z (over 2 years ago)
- Last Synced: 2025-02-27T12:16:20.431Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.55 MB
- Stars: 56
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# IDate
Iranian Date constractor for Javascript, Just like native javascript `Date`.
> Date convertor functions hard copied from [`jalaali-js`](https://github.com/jalaali/jalaali-js)
## Installation
```terminal
npm install idate --save
# or
yarn add idate
```
### Browser
```html
```
### Node, ESM
```javascript
import IDate from 'idate'
// or
const IDate = require('idate')
```
### Initialization
For initializing `IDate` you may either pass parameteres of Jalali date to it just like native Date. Other type of params like `Date` || `IDate` object or `ISOString` or `Milliseconds` also supported.
```javascript
new IDate()
new IDate(milliseconds)
new IDate(gregorianDateString)
new IDate(jalaliYear, jalaliMonth, jalaliDay, hours, minutes, seconds, milliseconds)
```
### API
```javascript
const date = new IDate(1396, 5, 5)
// Getters
date.getFullYear() // 1396
date.getMonth() // 5 (indexed from zero, so 5 is شهریور)
date.getDate() // 5 (day in month)
date.getDay() // 4 (day of week started from saturday and indexed from zero, so 4 is چهارشنبه)
// Setters
date.setFullYear(1371)
date.setMonth(6)
date.setDate(1)
// Formated output
date.toString(persianString = true) // چهارشنبه ۱ مهر ۱۳۷۱ ساعت ۰۰:۰۰:۰۰ or Chaharshanbe 1 Mehr 1371 00:00:00
date.toISOString() // 1992-09-22T20:30:00.000Z
```
### Difference with native Date?
`IDate` is an instance of native `Date`. All methods act just like the native API, so you can send `IDate` by AJAX libs to server or run `JSON.stringify` on it. Everything else works as well. It will also automatically convert to ISO.