# Mhah-Panchang

Its a cool package build to calculate Tithi (Moon), Nakshatra, Karna, Yoga, Raasi (Zodic Sign) and Ayanamsa. It can also be use to predict Masa(Hindu month) and Ritu (season).

<!-- ![Build Status](https://github.com/omkarpattanaik/mhah-panchanga/actions/workflows/main.yml/badge.svg)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![NPM](https://nodei.co/npm/mhah-panchang.png?compact=true)](https://nodei.co/npm/mhah-panchang/) -->

### Installation 🧱

Via npm:

```bash
npm install --save mhah-panchang
```

### Usage 🔌

```javascript
import { MhahPanchang } from 'mhah-panchanga';
// Or if you use CommonJS imports:
// const {MhahPanchang} = require('mhah-panchanga')

var obj = new MhahPanchang();
```

### Sample code 📑

```javascript
const { MhahPanchang } = require('mhah-panchang');

var obj = new MhahPanchang();

// Based current date and time : calculate(date)
var mhahObj = obj.calculate(new Date('2022-02-21T11:34:11.000Z'));
console.log(mhahObj);

// Based regular Hindu Calendar details : calendar(date, latitude, longitude)
let mhahCal = obj.calendar(
  new Date('2022-02-27T05:22:43.984Z'),
  12.972,
  77.594
);
console.log(mhahCal);
```

<a name="Content"></a>

## Content 📖

- [Mhah-Panchang](#mhah-panchang)
    - [Installation 🧱](#installation-)
    - [Usage 🔌](#usage-)
    - [Sample code 📑](#sample-code-)
  - [Content 📖](#content-)
  - [Calculate](#calculate)
    - [Day](#day)
    - [Paksha](#paksha)
    - [Tithi](#tithi)
    - [Nakshatra](#nakshatra)
    - [Karna](#karna)
    - [Yoga](#yoga)
    - [Ayanamsa](#ayanamsa)
    - [Raasi](#raasi)
    - [Julian Date](#julian-date)
    - [Gana](#gana)
    - [Guna](#guna)
    - [Trinity](#trinity)
  - [Calendar](#calendar)
    - [Tithi](#tithi-1)
    - [Paksha](#paksha-1)
    - [Nakshatra](#nakshatra-1)
    - [Yoga](#yoga-1)
    - [Karna](#karna-1)
    - [Masa](#masa)
    - [Raasi](#raasi-1)
    - [Ritu](#ritu)
    - [Gana](#gana-1)
    - [Guna](#guna-1)
    - [Trinity](#trinity-1)
  - [Customize Name](#customize-name)
    - [setMhahConstant](#setmhahconstant)
    - [getMhahConstant](#getmhahconstant)
  - [Sun and Moon Timer](#sun-and-moon-timer)
    - [solarNoon](#solarnoon)
    - [nadir](#nadir)
    - [sunRise](#sunrise)
    - [sunSet](#sunset)
    - [sunRiseEnd](#sunriseend)
    - [sunSetStart](#sunsetstart)
    - [dawn](#dawn)
    - [dusk](#dusk)
    - [nauticalDawn](#nauticaldawn)
    - [nauticalDusk](#nauticaldusk)
    - [nightEnd](#nightend)
    - [night](#night)
  - [License ⚖️](#license-️)

<a name="calculate"></a>

## Calculate

Here the Panchang calculation is focused on Date and Time taking in consideration the Julian Date, Sun and Moon.

```javascript
//calculate(date)
//Example
var mhahObj = obj.calculate(new Date('2022-02-21T11:34:11.000Z'));
console.log(mhahObj.Day);
```

**Inputs**

| Parameter | Type   | Description                      |
| :-------- | :----- | :------------------------------- |
| `date`    | `Date` | Date for which details is needed |

<a name="calculate+Day"></a>

### Day

**Example**

```javascript
console.log(mhahObj.Day);
```

**Output**

```chef
{ ino: 1, name: 'ସୋମବାର', name_en_UK: 'Monday' }
```

| Parameter    | Type     | Description                              |
| :----------- | :------- | :--------------------------------------- |
| `name`       | `string` | Day in custom language (_default_: Odia) |
| `name_en_UK` | `string` | Day in English (UK)                      |
| `ino`        | `number` | Index no. of Day                         |

<a name="calculate+Paksha"></a>

### Paksha

**Example**

```javascript
console.log(mhahObj.Paksha);
```

**Output**

```chef
{
    ino: 1,
    name: 'କୃଷ୍ଣ',
    name_en_IN: 'Krishna',
    name_en_UK: 'Waning Moon'
}
```

| Parameter    | Type     | Description                                |
| :----------- | :------- | :----------------------------------------- |
| `name`       | `string` | Tithi in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Tithi in English (India)                   |
| `name_en_UK` | `string` | Tithi in English (UK)                      |
| `ino`        | `number` | Index no. of Tithi                         |

<a name="calculate+Tithi"></a>

### Tithi

**Example**

```javascript
console.log(mhahObj.Tithi);
```

**Output**

```chef
{
    name: 'ପଞ୍ଚମୀ',
    name_en_IN: 'Panchami',
    ino: 19,
    start: 2022-02-20T15:35:33.000Z,
    end: 2022-02-21T14:27:50.000Z
}
```

| Parameter    | Type     | Description                                |
| :----------- | :------- | :----------------------------------------- |
| `name`       | `string` | Tithi in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Tithi in English (India)                   |
| `ino`        | `number` | Index no. of Tithi                         |
| `start`      | `Date`   | Start time of Tithi                        |
| `end`        | `Date`   | end time of Tithi                          |

<a name="calculate+Nakshatra"></a>

### Nakshatra

**Example**

```javascript
console.log(mhahObj.Nakshatra);
```

**Output**

```chef
{
    name: 'ସ୍ଵାତୀ',
    name_en_IN: 'Swati',
    ino: 14,
    start: 2022-02-21T10:46:30.000Z,
    end: 2022-02-22T10:05:49.000Z
}
```

| Parameter    | Type     | Description                                    |
| :----------- | :------- | :--------------------------------------------- |
| `name`       | `string` | Nakshatra in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Nakshatra in English (India)                   |
| `ino`        | `number` | Index no. of Nakshatra                         |
| `start`      | `Date`   | Start time of Nakshatra                        |
| `end`        | `Date`   | end time of Nakshatra                          |

<a name="calculate+Karna"></a>

### Karna

**Example**

```javascript
console.log(mhahObj.Karna);
```

**Output**

```chef
{
    name: 'ତୈତିଳ',
    name_en_IN: 'Taitula',
    ino: 3,
    start: 2022-02-21T03:03:39.000Z,
    end: 2022-02-21T14:27:50.000Z
}
```

| Parameter    | Type     | Description                                |
| :----------- | :------- | :----------------------------------------- |
| `name`       | `string` | Karna in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Karna in English (India)                   |
| `ino`        | `number` | Index no. of Karna                         |
| `start`      | `Date`   | Start time of Karna                        |
| `end`        | `Date`   | end time of Karna                          |

<a name="calculate+Yoga"></a>

### Yoga

**Example**

```javascript
console.log(mhahObj.Yoga);
```

**Output**

```chef
{
    name: 'ବୃଦ୍ଧି',
    name_en_IN: 'Vridhi',
    ino: 10,
    start: 2022-02-21T07:34:10.000Z,
    end: 2022-02-22T05:20:00.000Z
}
```

| Parameter    | Type     | Description                               |
| :----------- | :------- | :---------------------------------------- |
| `name`       | `string` | Yoga in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Yoga in English (UK)                      |
| `ino`        | `number` | Index no. of Yoga                         |
| `start`      | `Date`   | Start time of Yoga                        |
| `end`        | `Date`   | end time of Yoga                          |

<a name="calculate+Ayanamsa"></a>

### Ayanamsa

**Example**

```javascript
console.log(mhahObj.Ayanamsa);
```

**Output**

```chef
{ name: `24 9'48"` }
```

<a name="calculate+Raasi"></a>

### Raasi

**Example**

```javascript
console.log(mhahObj.Raasi);
```

**Output**

```chef
{ name: 'ତୁଳା', ino: 6, name_en_UK: 'Libra' }
```

| Parameter    | Type     | Description                                      |
| :----------- | :------- | :----------------------------------------------- |
| `name`       | `string` | Zodiac sign in custom language (_default_: Odia) |
| `name_en_UK` | `string` | Zodiac sign in English (UK)                      |
| `ino`        | `number` | Index no. of Zodiac sign                         |

<a name="calculate+Juldate"></a>

### Julian Date

**Example**

```javascript
console.log(mhahObj.Julian);
```

**Output**

```chef
{ date: 2459632.211111111, day: 2459632 }
```

### Gana

**Example**

```javascript
console.log(mhahObj.Gana);
```

**Output**

```chef
{
    "ino": 0,
    "name_en_IN": "Devata",
    "name_en_UK": "God",
    "name": "ଦେବତା"
}
```

| Parameter    | Type     | Description                                 |
| :----------- | :------- | :------------------------------------------ |
| `name`       | `string` | Gana in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Gana in English (India)                   |
| `name_en_UK` | `string` | Gana in English (UK)                      |
| `ino`        | `number` | Index no. of Gana                         |

### Guna

**Example**

```javascript
console.log(mhahObj.Guna);
```

**Output**

```chef
{
  "ino": 0,
  "name_en_IN": "Rajas",
  "name_en_UK": "passion, activity, movement",
  "name": "ରାଜସ୍"
}
```

| Parameter    | Type     | Description                                 |
| :----------- | :------- | :------------------------------------------ |
| `name`       | `string` | Guna in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Guna in English (India)                   |
| `name_en_UK` | `string` | Guna in English (UK)                      |
| `ino`        | `number` | Index no. of Guna                         |

### Trinity

**Example**

```javascript
console.log(mhahObj.Trinity);
```

**Output**

```chef
{
  "ino": 1,
  "name_en_IN": "Vishnu",
  "name": "ବିଷ୍ଣୁ"
}
```

| Parameter    | Type     | Description                                 |
| :----------- | :------- | :------------------------------------------ |
| `name`       | `string` | Trinity in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Trinity in English (India)                   |
| `ino`        | `number` | Index no. of Trinity                         |

<a name="calendar"></a>

## Calendar

Here the Panchang calculation is focused on Hindu Calendar.

```javascript
//calendar(date, latitude, longitude)
// Example
let mhahCal = obj.calendar(
  new Date('2022-02-27T05:22:43.984Z'),
  12.972,
  77.594
);

console.log(mhahCal);
`````

**Inputs**

| Parameter   | Type     | Description                      |
| :---------- | :------- | :------------------------------- |
| `date`      | `Date`   | Date for which details is needed |
| `latitude`  | `number` | Latitude coordinate of Place     |
| `longitude` | `number` | Longitude coordinate of Place    |

<a name="calendar+Tithi"></a>

### Tithi

**Example**

```javascript
console.log(mhahCal.Tithi);
```

**Output**

```chef
{ name: 'ଦ୍ଵାଦଶୀ', name_en_IN: 'Dvadasi', ino: 26 }
```

| Parameter    | Type     | Description                                |
| :----------- | :------- | :----------------------------------------- |
| `name`       | `string` | Tithi in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Tithi in English (IN)                      |
| `ino`        | `number` | Index no. of Tithi                         |

<a name="calendar+Paksha"></a>

### Paksha

**Example**

```javascript
console.log(mhahCal.Paksha);
```

**Output**

```chef
{
    ino: 1,
    name: 'କୃଷ୍ଣ',
    name_en_IN: 'Krishna',
    name_en_UK: 'Waning Moon'
}
```

| Parameter    | Type     | Description                                 |
| :----------- | :------- | :------------------------------------------ |
| `name`       | `string` | Paksha in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Paksha in English (India)                   |
| `name_en_UK` | `string` | Paksha in English (UK)                      |
| `ino`        | `number` | Index no. of Paksha                         |

<a name="calendar+Nakshatra"></a>

### Nakshatra

**Example**

```javascript
console.log(mhahCal.Nakshatra);
```

**Output**

```chef
{ name: 'ପୂର୍ବଷାଢା', name_en_IN: 'Purva Ashadha', ino: 19 }
```

| Parameter    | Type     | Description                                    |
| :----------- | :------- | :--------------------------------------------- |
| `name`       | `string` | Nakshatra in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Nakshatra in English (India)                   |
| `ino`        | `number` | Index no. of Nakshatra                         |

<a name="calendar+Yoga"></a>

### Yoga

**Example**

```javascript
console.log(mhahCal.Yoga);
```

**Output**

```chef
{ name: 'ବ୍ୟତିପାତ', name_en_IN: 'Vyatipata', ino: 16 }
```

| Parameter    | Type     | Description                               |
| :----------- | :------- | :---------------------------------------- |
| `name`       | `string` | Yoga in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Yoga in English (UK)                      |
| `ino`        | `number` | Index no. of Yoga                         |

<a name="calendar+Karna"></a>

### Karna

**Example**

```javascript
console.log(mhahCal.Karna);
```

**Output**

```chef
{ name: 'ବାଳବ', name_en_IN: 'Balava', ino: 1 }
```

| Parameter    | Type     | Description                                |
| :----------- | :------- | :----------------------------------------- |
| `name`       | `string` | Karna in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Karna in English (India)                   |
| `ino`        | `number` | Index no. of Karna                         |

<a name="calendar+Masa"></a>

### Masa

**Example**

```javascript
console.log(mhahCal.Masa);
```

**Output**

```chef
{
    ino: 10,
    name: 'ଫାଲ୍ଗୁନ',
    name_en_UK: 'Phalguna'
}
```

| Parameter    | Type     | Description                                      |
| :----------- | :------- | :----------------------------------------------- |
| `name`       | `string` | Zodiac sign in custom language (_default_: Odia) |
| `name_en_UK` | `string` | Zodiac sign in English (UK)                      |
| `ino`        | `number` | Index no. of Zodiac sign                         |

<a name="calendar+Raasi"></a>

### Raasi

**Example**

```javascript
console.log(mhahCal.Raasi);
```

**Output**

```chef
{ ino: 10, name_en_UK: 'Aquarius', name: 'କୁମ୍ଭ' }
```

| Parameter    | Type     | Description                                      |
| :----------- | :------- | :----------------------------------------------- |
| `name`       | `string` | Zodiac sign in custom language (_default_: Odia) |
| `name_en_UK` | `string` | Zodiac sign in English (UK)                      |
| `ino`        | `number` | Index no. of Zodiac sign                         |

<a name="calendar+Ritu"></a>

### Ritu

**Example**

```javascript
console.log(mhahCal.Ritu);
```

**Output**

```chef
{ ino: 5, name: 'ବସନ୍ତ', name_en_UK: 'Winter' }
```

| Parameter    | Type     | Description                                    |
| :----------- | :------- | :--------------------------------------------- |
| `name`       | `string` | Ritu sign in custom language (_default_: Odia) |
| `name_en_UK` | `string` | Ritu sign in English (UK)                      |
| `ino`        | `number` | Index no. of Ritu                              |

### Gana

**Example**

```javascript
console.log(mhahObj.Gana);
```

**Output**

```chef
{
  "ino": 1,
  "name_en_IN": "Manushya",
  "name_en_UK": "Human",
  "name": "ମନୁଷ୍ୟ"
}
```

| Parameter    | Type     | Description                               |
| :----------- | :------- | :---------------------------------------- |
| `name`       | `string` | Gana in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Gana in English (India)                   |
| `name_en_UK` | `string` | Gana in English (UK)                      |
| `ino`        | `number` | Index no. of Gana                         |

### Guna

**Example**

```javascript
console.log(mhahObj.Guna);
```

**Output**

```chef
{
    "ino": 1,
    "name_en_IN": "Tamas",
    "name_en_UK": "ignorance, inertia, laziness",
    "name": "ତମାସ୍"
}
```

| Parameter    | Type     | Description                               |
| :----------- | :------- | :---------------------------------------- |
| `name`       | `string` | Guna in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Guna in English (India)                   |
| `name_en_UK` | `string` | Guna in English (UK)                      |
| `ino`        | `number` | Index no. of Guna                         |

### Trinity

**Example**

```javascript
console.log(mhahObj.Trinity);
```

**Output**

```chef
{
  "ino": 2,
  "name_en_IN": "Shiva",
  "name": "ଶିବ"
}
```

| Parameter    | Type     | Description                                 |
| :----------- | :------- | :------------------------------------------ |
| `name`       | `string` | Trinity in custom language (_default_: Odia) |
| `name_en_IN` | `string` | Trinity in English (India)                   |
| `ino`        | `number` | Index no. of Trinity                         |

## Customize Name

Name variable can be customize with users own value.

### setMhahConstant

To set custome variable
**Example**

```javascript
import { MhahPanchang } from 'mhah-panchanga';
let obj = new MhahPanchang();
let customArray = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
obj.setMhahConstant('Day', 'name', customArray);
var mhahObj = obj.calculate(new Date('2022-02-21T11:34:11.000Z'));
console.log(mhahObj.Day.name); // Mon
```

### getMhahConstant

To get custome variable after its set or to see default variable
**Example**

```javascript
import { MhahPanchang } from 'mhah-panchanga';
let obj = new MhahPanchang();
console.log(obj.getMhahConstant('Day', 'name'));
```

## Sun and Moon Timer

```javascript
import { MhahPanchang } from 'mhah-panchanga';
let obj = new MhahPanchang();

// Based Day important timing : calendar(date, latitude, longitude)
let mhahCal = obj.sunTimer(
  new Date('2022-02-26T05:22:43.984Z'),
  12.972,
  77.594
);
```

### solarNoon

Time when sun is in the highest position.

**Example**

```javascript
console.log(mhahCal.solarNoon).toEqual(new Date('2022-02-26T07:04:04.744Z'));
```

### nadir

Time when darkest moment of the night, sun is in the lowest position.

**Example**

```javascript
console.log(mhahCal.nadir).toEqual(new Date('2022-02-25T19:04:04.744Z'));
```

### sunRise

Top edge of the sun appears on the horizon

**Example**

```javascript
console.log(mhahCal.sunRise);
```

### sunSet

Sun disappears below the horizon, evening civil twilight starts

**Example**

```javascript
console.log(mhahCal.sunSet);
```

### sunRiseEnd

Bottom edge of the sun touches the horizon

**Example**

```javascript
console.log(mhahCal.sunRiseEnd);
```

### sunSetStart

Bottom edge of the sun touches the horizon

**Example**

```javascript
console.log(mhahCal.sunSetStart);
```

### dawn

Morning nautical twilight ends, morning civil twilight starts

**Example**

```javascript
console.log(mhahCal.dawn);
```

### dusk

Evening nautical twilight starts

**Example**

```javascript
console.log(mhahCal.dusk);
```

### nauticalDawn

Morning nautical twilight starts

**Example**

```javascript
console.log(mhahCal.nauticalDawn);
```

### nauticalDusk

Evening astronomical twilight starts

**Example**

```javascript
console.log(mhahCal.nauticalDusk);
```

### nightEnd

Morning astronomical twilight starts

**Example**

```javascript
console.log(mhahCal.nightEnd);
```

### night

Dark enough for astronomical observations

**Example**

```javascript
console.log(mhahCal.night);
```

## License ⚖️

MPL