Merge branch 'main' into nepal-timezone-date-class

Author: sajin-shrestha

.release-please-manifest.json

@@ -1 +1 @@
-{".":"1.4.1"}
+{".":"1.5.0"}

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [1.5.0](https://github.com/opensource-nepal/node-nepali-datetime/compare/v1.4.1...v1.5.0) (2025-09-03)
+
+
+### Features
+
+* add parseNepaliFormat method on NepaliDate ([#111](https://github.com/opensource-nepal/node-nepali-datetime/issues/111)) ([ff4a05b](https://github.com/opensource-nepal/node-nepali-datetime/commit/ff4a05b6e2ce09d8ffa31a56a64b4fce54a2618b))
+
 ## [1.4.1](https://github.com/opensource-nepal/node-nepali-datetime/compare/v1.4.0...v1.4.1) (2025-04-08)
 
 

README.md

@@ -194,6 +194,14 @@ For the list of month names and their abbreviations, you can refer to the table
 | 10             | Fal          | Falgun    |
 | 11             | Cha          | Chaitra   |
 
+#### Parsing Dates
+
+You can parse a date-time string into a `NepaliDate` object using the following methods:
+
+- `new NepaliDate(dateString, formatStr)`: Parses an Nepali date-time string according to the specified format.
+- `NepaliDate.parseNepaliFormat(dateStringNe, formatStr)`: Parses a Nepali date-time string in Devanagari form according to the specified format.
+- `NepaliDate.parseEnglishDate(dateString, formatStr)`: Parses an English date-time string according to the specified format.
+
 #### Converting to JavaScript Date object
 
 You can get the equivalent JavaScript `Date` object of a `NepaliDate` object using the `getDateObject()` method.

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "nepali-datetime",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "A Node project designed to support native JavaScript-like features for Nepali dates. It includes features such as 'NepaliDate' for Nepali date support and 'dateConverter' for date conversions.",
     "exports": {
         ".": {

package.json

@@ -9,7 +9,12 @@ import {
 } from './format'
 import NepalTimezoneDate from './NepalTimezoneDate'
 
-import { parse, parseFormat, parseEnglishDateFormat } from './parse'
+import {
+    simpleParse,
+    parseFormat,
+    parseEnglishDateFormat,
+    parseNepaliFormat,
+} from './parse'
 import { validateTime } from './validators'
 
 /**
@@ -183,7 +188,7 @@ class NepaliDate {
     }
 
     private parseFromString(value: string) {
-        const parsedResult = parse(value)
+        const parsedResult = simpleParse(value)
         this.set(
             parsedResult[0], // Year
             parsedResult[1], // Month
@@ -263,7 +268,7 @@ class NepaliDate {
      *
      * @returns {Date} The equivalent JavaScript Date object.
      */
-    getDateObject() {
+    getDateObject(): Date {
         return this.timestamp
     }
 
@@ -653,8 +658,27 @@ class NepaliDate {
     }
 
     /**
-     * Creates a NepaliDate instance by parsing a provided English Date and Time string
-     * with the given format.
+     * Parses a Nepali date-time string in Devanagari form according to the
+     * specified format and returns a `NepaliDate` instance.
+     *
+     * @param dateStringNe - The Nepali Date and time string in Devanagari.
+     * @param format - The format of the provided date-time string.
+     * @example
+     * const dateStringNe = '२०८०/०८/१२ १४-०५-२३.७८९'
+     * const format = 'YYYY/MM/DD HH-mm-ss.SSS'
+     * const nepaliDate = NepaliDate.parseNepaliFormat(dateStringNe, format)
+     */
+    static parseNepaliFormat(dateStringNe: string, format: string): NepaliDate {
+        const [year, month0, day, hour, minute, second, ms] = parseNepaliFormat(
+            dateStringNe,
+            format
+        )
+        return new NepaliDate(year, month0, day, hour, minute, second, ms)
+    }
+
+    /**
+     * Parses an English date-time string according to the specified format
+     * and returns a `NepaliDate` instance.
      *
      * @param dateString - The English Date and time string.
      * @param format - The format of the provided date-time string.

src/NepaliDate.ts

@@ -1,2 +1,3 @@
-export { parseFormat, parse } from './parse'
+export { parseFormat, simpleParse } from './parse'
 export { parseEnglishDateFormat } from './parseEnglishDate'
+export { parseNepaliFormat } from './parseNepaliFormat'

src/parse/index.ts

@@ -1,15 +1,5 @@
 /**
- * parse.ts
- *
- * This module provides methods for parsing dates and times from strings.
- *
- * Functions:
- *
- * parse(dateTimeString)
- * - Parses date and time from the given string.
- *
- * Further extension is needed in this module as there are limited formats supported for parsing.
- * Developers should consider extending the module to support additional date and time formats.
+ * This module provides features for parsing Nepali Date strings (in English).
  */
 
 import {
@@ -92,7 +82,7 @@ function parseTimeString(timeString: string): number[] {
  * @throws {Error} if date or time string is invalid
  * @returns return array of date information [hour, minute, second, ms].
  */
-export function parse(dateTimeString: string): number[] {
+export function simpleParse(dateTimeString: string): number[] {
     const [dateString, timeString] = dateTimeString.split(' ', 2)
     const [year, month0, day] = parseDateString(dateString)
     const [hour, minute, second, ms] = parseTimeString(timeString)

src/parse/parse.ts

@@ -1,3 +1,7 @@
+/**
+ * This module provides methods for parsing English Date strings.
+ */
+
 import {
     ENGLISH_MONTHS_EN,
     ENGLISH_MONTHS_SHORT_EN,

src/parse/parseEnglishDate.ts

@@ -0,0 +1,36 @@
+/**
+ * This module provides methods for parsing Nepali Date strings (in Devanagari).
+ */
+
+import {
+    NEPALI_MONTHS_EN,
+    NEPALI_MONTHS_NE,
+    NUM_NE,
+    WEEKDAYS_LONG_EN,
+    WEEKDAYS_LONG_NE,
+    WEEKDAYS_SHORT_EN,
+    WEEKDAYS_SHORT_NE,
+} from '../constants'
+import { parseFormat } from './parse'
+
+function convertNepaliStringToEnglish(dateStringNe: string): string {
+    const regexLookup: Record<string, string> = {
+        एम: 'AM',
+        पिम: 'PM',
+    }
+    NEPALI_MONTHS_NE.forEach((ne, i) => (regexLookup[ne] = NEPALI_MONTHS_EN[i]))
+    WEEKDAYS_LONG_NE.forEach((ne, i) => (regexLookup[ne] = WEEKDAYS_LONG_EN[i]))
+    WEEKDAYS_SHORT_NE.forEach((ne, i) => (regexLookup[ne] = WEEKDAYS_SHORT_EN[i]))
+    NUM_NE.forEach((ne, i) => (regexLookup[ne] = String(i)))
+
+    // create a regex pattern
+    const pattern = new RegExp(Object.keys(regexLookup).join('|'), 'g')
+
+    // replace the match
+    return dateStringNe.replace(pattern, match => regexLookup[match])
+}
+
+export function parseNepaliFormat(dateStringNe: string, format: string): number[] {
+    const convertedDateString = convertNepaliStringToEnglish(dateStringNe)
+    return parseFormat(convertedDateString, format)
+}