Skip to content

Commit

Permalink
fix: indian calculation method
Browse files Browse the repository at this point in the history 
This PR will fix indian date calculation method

BREAKING CHANGE: This will fix indian calculation method
  • Loading branch information
@sh4hids
sh4hids committed Jun 19, 2023
1 parent 38e3fe7 commit b1ada14
Showing 1 changed file with 42 additions and 35 deletions.
77 changes: 42 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,19 @@ This method returns full Bangla date for a given date.
const date1 = new Date('August 16 2019 06:22:03');

getDate(date1); //output: শুক্রবার, ১ ভাদ্র, ১৪২৬
getDate(date1, { format: 'DD/MM/YY' }); //output: ০১/০৫/২৬
getDate(date1, { format: 'DD/MM/YYYY' }); //output: ০১/০৫/১৪২৬
getDate(date1, { format: 'DD/MM/YYYYb' }); //output: ০১/০৫/১৪২৬ (বঙ্গাব্দ)
getDate(date1, { format: 'D MMMM, YYYY' }); //output: ১ ভাদ্র, ১৪২৬
getDate(date1, { format: 'D MMMM, YYYYb' }); //output: ১ ভাদ্র, ১৪২৬ (বঙ্গাব্দ)
getDate(date1, { format: 'DD/MM/YY', calculationMethod: 'BD' }); //output: ০১/০৫/২৬
getDate(date1, { format: 'DD/MM/YYYY', calculationMethod: 'BD' }); //output: ০১/০৫/১৪২৬
getDate(date1, { format: 'DD/MM/YYYYb', calculationMethod: 'BD' }); //output: ০১/০৫/১৪২৬ (বঙ্গাব্দ)
getDate(date1, { format: 'D MMMM, YYYY', calculationMethod: 'BD' }); //output: ১ ভাদ্র, ১৪২৬
getDate(date1, { format: 'D MMMM, YYYYb', calculationMethod: 'BD' }); //output: ১ ভাদ্র, ১৪২৬ (বঙ্গাব্দ)
```

#### Parameters

| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'D MMMM, YYYY' }` |
| Parameter | Type | Example |
| --------- | --------------- | ----------------------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'D MMMM, YYYY', calculationMethod: 'BD' }` |

### `getDay(date, {})`

Expand All @@ -75,16 +75,16 @@ This method returns the day of the Bangla month of the given date.
const date1 = new Date('August 16 2019 06:22:03');

getDay(date1); //output: ১
getDay(date1, { format: 'DD' }); //output: ০১
getDay(date1, { format: 'D' }); //output: ১
getDay(date1, { format: 'DD', calculationMethod: 'BD' }); //output: ০১
getDay(date1, { format: 'D', calculationMethod: 'BD' }); //output: ১
```

#### Parameters

| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'D' }` |
| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------------ |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'D', calculationMethod: 'BD' }` |

### `getWeekDay(date, {})`

Expand All @@ -96,16 +96,16 @@ This method returns the day of the Bangla week of the given date.
const date1 = new Date('August 16 2019 06:22:03');

getWeekDay(date1); //output: শুক্রবার
getWeekDay(date1, { format: 'eeee' }); //output: শুক্রবার
getWeekDay(date1, { format: 'eee' }); //output: শুক্র
getWeekDay(date1, { format: 'eeee', calculationMethod: 'BD' }); //output: শুক্রবার
getWeekDay(date1, { format: 'eee', calculationMethod: 'BD' }); //output: শুক্র
```

#### Parameters

| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'eeee'}` |
| Parameter | Type | Example |
| --------- | --------------- | --------------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'eeee', calculationMethod: 'BD' }` |

### `getMonth(date, {})`

Expand All @@ -117,17 +117,17 @@ This method returns the Bangla month of a given date.
const date1 = new Date('August 16 2019 06:22:03');

getMonth(date1); //output: ভাদ্র
getMonth(date1, { format: 'M' }); //output: ১
getMonth(date1, { format: 'MM' }); //output: ০১
getMonth(date1, { format: 'MMMM' }); //output: ভাদ্র
getMonth(date1, { format: 'M', calculationMethod: 'BD' }); //output: ১
getMonth(date1, { format: 'MM', calculationMethod: 'BD' }); //output: ০১
getMonth(date1, { format: 'MMMM', calculationMethod: 'BD' }); //output: ভাদ্র
```

#### Parameters

| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'MMMM' }` |
| Parameter | Type | Example |
| --------- | --------------- | --------------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'MMMM', calculationMethod: 'BD' }` |

### `getYear(date, {})`

Expand All @@ -139,20 +139,27 @@ This method returns the Bangla year of a given date.
const date1 = new Date('August 16 2019 06:22:03');

getYear(date1); //output: ১৪২৬
getYear(date1, { format: 'YY' }); //output: ২৬
getYear(date1, { format: 'YYYY' }); //output: ১৪২৬
getYear(date1, { format: 'YYYYb' }); //output: ১৪২৬ (বঙ্গাব্দ)
getYear(date1, { format: 'YY', calculationMethod: 'BD' }); //output: ২৬
getYear(date1, { format: 'YYYY', calculationMethod: 'BD' }); //output: ১৪২৬
getYear(date1, { format: 'YYYYb', calculationMethod: 'BD' }); //output: ১৪২৬ (বঙ্গাব্দ)
```

#### Parameters

| Parameter | Type | Example |
| --------- | --------------- | ------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'YYYY' }` |
| Parameter | Type | Example |
| --------- | --------------- | --------------------------------------------- |
| date | JavaScript date | `new Date('August 16 2019 06:22:03')` |
| options | object | `{ format: 'YYYY', calculationMethod: 'BD' }` |

## Options

#### calculationMethod (string)

| Country | Token |
| ---------- | ----- |
| Bangladesh | BD |
| India | IN |

#### format (string)

| Unit | Token | Result examples |
Expand Down

0 comments on commit b1ada14

Please sign in to comment.