idate
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

IDate

Iranian Date constractor for Javascript, Just like native javascript Date.

Date convertor functions hard copied from jalaali-js

Installation

npm install idate --save
# or
yarn add idate

Browser

<head>
  <script src="path/to/idate/dist/idate.js"></script>
  <!-- or -->
  <script src="path/to/idate/dist/idate.min.js"></script>
</head>

Node, ESM

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.

new IDate()
new IDate(milliseconds)
new IDate(gregorianDateString)
new IDate(jalaliYear, jalaliMonth, jalaliDay, hours, minutes, seconds, milliseconds)

API

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.

Package Sidebar

Install

npm i idate

Weekly Downloads

4

Version

0.2.0

License

ISC

Unpacked Size

62 kB

Total Files

13

Last publish

Collaborators

  • nainemom