@@ -60,41 +60,41 @@ The `NepaliDate` class represents a Nepali calendar date. It provides various me
6060
6161You can create a ` NepaliDate ` object in several ways:
6262
63- - Without any parameters: Creates a ` NepaliDate ` object for the current date and time.
63+ - Without any parameters: Creates a ` NepaliDate ` object for the current date and time.
6464
6565 ``` javascript
6666 import NepaliDate from ' nepali-datetime'
6767
6868 const now = new NepaliDate ()
6969 ```
7070
71- - Using a Nepali date string: Parses the string as a Nepali calendar date.
71+ - Using a Nepali date string: Parses the string as a Nepali calendar date.
7272
7373 ` ` ` javascript
7474 const date1 = new NepaliDate('2079-02-15')
7575 const date2 = new NepaliDate('2079-02-15 14:00')
7676 ` ` `
7777
78- - Using a Unix timestamp (in milliseconds):
78+ - Using a Unix timestamp (in milliseconds):
7979
8080 ` ` ` javascript
8181 const date2 = new NepaliDate(1654210800000)
8282 ` ` `
8383
84- - Using a JavaScript ` Date` object: Converts the JavaScript ` Date` object to a ` NepaliDate` object.
84+ - Using a JavaScript ` Date` object: Converts the JavaScript ` Date` object to a ` NepaliDate` object.
8585
8686 ` ` ` javascript
8787 const jsDate = new Date()
8888 const date3 = new NepaliDate(jsDate)
8989 ` ` `
9090
91- - Using an existing ` NepaliDate` object: Creates a new ` NepaliDate` object with the same values.
91+ - Using an existing ` NepaliDate` object: Creates a new ` NepaliDate` object with the same values.
9292
9393 ` ` ` javascript
9494 const date4 = new NepaliDate(date3)
9595 ` ` `
9696
97- - Using Nepali calendar date and time parameters: Specifies the components of a Nepali calendar date.
97+ - Using Nepali calendar date and time parameters: Specifies the components of a Nepali calendar date.
9898
9999 ` ` ` javascript
100100 const date5 = new NepaliDate(year, month, date, hour, minute, second, ms)
@@ -105,42 +105,42 @@ You can create a `NepaliDate` object in several ways:
105105
106106You can retrieve various components of a ` NepaliDate` object using the following methods:
107107
108- - ` getDateObject()` : Retrieves the Javascript Date object equivalent to the NepaliDate.
109- - ` getTime()` : Retrieves the Unix timestamp (in milliseconds) of the Nepali date.
110- - ` getYear()` : Retrieves the year of the Nepali date in the Nepali calendar.
111- - ` getEnglishYear()` : Retrieves the year of the Nepali date in the English calendar.
112- - ` getMonth()` : Retrieves the month of the Nepali date in the Nepali calendar.
113- - ` getEnglishMonth()` : Retrieves the month of the Nepali date in the English calendar.
114- - ` getDate()` : Retrieves the day of the month of the Nepali date in the Nepali calendar.
115- - ` getEnglishDate()` : Retrieves the day of the month of the Nepali date in the English calendar.
116- - ` getDay()` : Retrieves the day of the week represented by a numeric value.
117- - ` getHours()` : Retrieves the hour value of the Nepali date.
118- - ` getMinutes()` : Retrieves the minute value of the Nepali date.
119- - ` getSeconds()` : Retrieves the second value of the Nepali date.
120- - ` getMilliseconds()` : Retrieves the millisecond value of the Nepali date.
108+ - ` getDateObject()` : Retrieves the Javascript Date object equivalent to the NepaliDate.
109+ - ` getTime()` : Retrieves the Unix timestamp (in milliseconds) of the Nepali date.
110+ - ` getYear()` : Retrieves the year of the Nepali date in the Nepali calendar.
111+ - ` getEnglishYear()` : Retrieves the year of the Nepali date in the English calendar.
112+ - ` getMonth()` : Retrieves the month of the Nepali date in the Nepali calendar.
113+ - ` getEnglishMonth()` : Retrieves the month of the Nepali date in the English calendar.
114+ - ` getDate()` : Retrieves the day of the month of the Nepali date in the Nepali calendar.
115+ - ` getEnglishDate()` : Retrieves the day of the month of the Nepali date in the English calendar.
116+ - ` getDay()` : Retrieves the day of the week represented by a numeric value.
117+ - ` getHours()` : Retrieves the hour value of the Nepali date.
118+ - ` getMinutes()` : Retrieves the minute value of the Nepali date.
119+ - ` getSeconds()` : Retrieves the second value of the Nepali date.
120+ - ` getMilliseconds()` : Retrieves the millisecond value of the Nepali date.
121121
122122#### Setting the Nepali date components
123123
124124You can set individual components of a ` NepaliDate` object using the following methods:
125125
126- - ` setYear(year)` : Sets the year of the Nepali date.
127- - ` setMonth(month)` : Sets the month of the Nepali date.
128- - ` setDate(day)` : Sets the day of the month of the Nepali date.
129- - ` setHours(hour)` : Sets the hour of the Nepali date.
130- - ` setMinutes(minute)` : Sets the minute of the Nepali date.
131- - ` setSeconds(second)` : Sets the second of the Nepali date.
132- - ` setMilliseconds(ms)` : Sets the millisecond of the Nepali date.
133- - ` setTime(time)` : Sets the Nepali date and time values using a Unix timestamp.
126+ - ` setYear(year)` : Sets the year of the Nepali date.
127+ - ` setMonth(month)` : Sets the month of the Nepali date.
128+ - ` setDate(day)` : Sets the day of the month of the Nepali date.
129+ - ` setHours(hour)` : Sets the hour of the Nepali date.
130+ - ` setMinutes(minute)` : Sets the minute of the Nepali date.
131+ - ` setSeconds(second)` : Sets the second of the Nepali date.
132+ - ` setMilliseconds(ms)` : Sets the millisecond of the Nepali date.
133+ - ` setTime(time)` : Sets the Nepali date and time values using a Unix timestamp.
134134
135135#### Formatting the Nepali date
136136
137137You can format a ` NepaliDate` object as a string using the ` format()` and ` formatNepali()` methods.
138138Additionally, you can convert the corresponding English date to a string using the ` formatEnglishDate()` and ` formatEnglishDateInNepali()` methods.
139139
140- - ` format(formatStr)` : Returns a string representation (in English) of the ` NepaliDate` object in the specified format.
141- - ` formatNepali(formatStr)` : Returns a string representation in the Nepali (Devanagari script) of the ` NepaliDate` object in the specified format.
142- - ` formatEnglishDate(formatStr)` : Returns a string representation (in English) of the English Date in the specified format.
143- - ` formatEnglishDateInNepali(formatStr)` : Returns a string representation in the Nepali (Devanagari script) of the English Date in the specified format.
140+ - ` format(formatStr)` : Returns a string representation (in English) of the ` NepaliDate` object in the specified format.
141+ - ` formatNepali(formatStr)` : Returns a string representation in the Nepali (Devanagari script) of the ` NepaliDate` object in the specified format.
142+ - ` formatEnglishDate(formatStr)` : Returns a string representation (in English) of the English Date in the specified format.
143+ - ` formatEnglishDateInNepali(formatStr)` : Returns a string representation in the Nepali (Devanagari script) of the English Date in the specified format.
144144
145145` ` ` javascript
146146const date = new NepaliDate(2079, 5, 3, 16, 14)
@@ -217,14 +217,14 @@ console.log(date2.toString()) // 2080-03-23 10:15:00
217217
218218#### Others
219219
220- - ` NepaliDate.getDaysOfMonth(year, month)` : Returns the number of days in a specific month of a given year.
220+ - ` NepaliDate.getDaysOfMonth(year, month)` : Returns the number of days in a specific month of a given year.
221221
222222### dateConverter
223223
224224The ` dateConverter` module provides core functions for converting dates between the Nepali and English calendars.
225225
226- - ` englishToNepali(year, month, day)` : Converts an English calendar date to a Nepali calendar date . Returns an array ` [npYear, npMonth, npDay]` representing the Nepali date.
227- - ` nepaliToEnglish(year, month, day)` : Converts a Nepali calendar date to an English calendar date . Returns an array ` [enYear, enYear, enDay]` representing the English date.
226+ - ` englishToNepali(year, month, day)` : Converts an English calendar date to a Nepali calendar date . Returns an array ` [npYear, npMonth, npDay]` representing the Nepali date.
227+ - ` nepaliToEnglish(year, month, day)` : Converts a Nepali calendar date to an English calendar date . Returns an array ` [enYear, enYear, enDay]` representing the English date.
228228
229229> Note: Use 0 as the value for the months Baisakh and January (Javascript Logic 🤷).
230230
0 commit comments