Shamc NPM | npm.io

Shamc

The Shamc package is a lightweight JavaScript library for working with jalali date. It provides a simple and intuitive API for performing common date operations compatible with javascript built-in Date object.

Features

Parsing and formatting dates
Converting Jalali to Gregorian
Working with time zones
Compatible with javascript built-in Date object

Installation

You can install the ShamcDate package via npm:

npm install shamc

Usage

To use the ShamcDate package in your JavaScript project, you can import it as follows:

import ShamcDate from 'shamc';

Once imported, you can create a new ShamcDate object and start using its methods:

const date = new ShamcDate('2020/01/01');
console.log(date.getShamcMonthName());    // "دی"
console.log(date.getShamcMonth());        // 9
console.log(date.getShamcDayName());      // "چهارشنبه"
console.log(date.getShamcDay());          // 4
console.log(date.getShamcYear());         // 1398
console.log(date.getShamcDate());         // 11
console.log(date.toShamcString());        // "1398/10/11"

Or you can create a date from Jalali date string:

const date2 = ShamcDate.fromJalali('1398/10/11');
console.log(date2.getShamcMonthName());    // "دی"
console.log(date2.getShamcMonth());        // 9
console.log(date2.getShamcDayName());      // "چهارشنبه"
console.log(date2.getShamcDay());          // 4
console.log(date2.getShamcYear());         // 1398
console.log(date2.getShamcDate());         // 11
console.log(date2.toShamcString());        // "1398/10/11"

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request on the GitHub repository.