fix: update description

deriv-com · Sep 25, 2024 · 47fd41c · 47fd41c
1 parent f1d90a8
commit 47fd41c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 20 deletions.
diff --git a/src/utils/format.utils.ts b/src/utils/format.utils.ts
@@ -51,15 +51,16 @@ export const formatMoney = (number: number, options?: FormatMoneyOptions) => {
 /**
  * Converts and formats a given date input into a specified string format without usage of external libraries such as moment.js or date-fns.
  *
- * @param {Date | number | string} dateInput - The date to be formatted. Can be a Date object, Unix timestamp, or date string.
- * @param {Intl.DateTimeFormatOptions} [options] - Optional configuration for date formatting. Defaults to { day: "2-digit", month: "2-digit", year: "numeric" }.
- * @param {string} [format="YYYY-MM-DD"] - The desired output format. Supported formats: 'YYYY-MM-DD', 'DD MMM YYYY', 'MMM DD YYYY'.
+ * @param {Date | number | string} dateInput - The date to be formatted.
+ *   - Can be a Date object, Unix timestamp, or date string.
+ * @param {Intl.DateTimeFormatOptions} [options] - Optional configuration for date formatting.
+ *   - Defaults to { day: "2-digit", month: "2-digit", year: "numeric" }.
+ * @param {string} [format="YYYY-MM-DD"] - The desired output format.
+ *   - Supported formats: 'YYYY-MM-DD', 'DD MMM YYYY', 'MMM DD YYYY'.
  * @param {boolean} [unix=false] - If true, treats the numeric input as a Unix timestamp.
  *
  * @returns {string} A formatted date string according to the specified format.
  *
- * @throws {Error} If the date input is invalid.
- *
  * @example
  * // Returns date in 'YYYY-MM-DD' format
  * getFormattedDateString(new Date('2023-05-15'));
@@ -117,13 +118,12 @@ export const getFormattedDateString = (
 /**
  * Converts and formats a given date input into a time string in 'HH:mm:ss GMT' format without usage of external libraries such as moment.js or date-fns.
  *
- * @param {Date | number | string} dateInput - The date to be formatted. Can be a Date object, Unix timestamp, or date string.
+ * @param {Date | number | string} dateInput - The date to be formatted.
+ *   - Can be a Date object, Unix timestamp, or date string.
  * @param {boolean} [unix=false] - If true, treats the numeric input as a Unix timestamp.
  *
  * @returns {string} A formatted time string in 'HH:mm:ss GMT' format.
  *
- * @throws {Error} If the date input is invalid.
- *
  * @example
  * getFormattedTimeString(new Date('2023-05-15T14:30:00Z'));
  * // => "14:30:00 GMT"

diff --git a/utils-docs/docs/Utils/format.md b/utils-docs/docs/Utils/format.md
@@ -61,10 +61,6 @@ Converts and formats a given date input into a specified string format. To be us
 
 A formatted date string according to the specified format.
 
-### Throws:
-
-Throws an error if the date input is invalid.
-
 ### Examples:
 
 ```js
@@ -92,10 +88,6 @@ Converts and formats a given date input into a time string in the `'HH:mm:ss GMT
 
 A formatted time string in the `'HH:mm:ss GMT'` format.
 
-### Throws:
-
-Throws an error if the date input is invalid.
-
 ### Examples:
 
 ```js
@@ -132,9 +124,6 @@ getAdjustedDate(5, "days", "add");
 
 // Returns a Date object 2 years in the past
 getAdjustedDate(2, "years", "subtract");
-
-// Returns a Date object 10 days in the past
-getAdjustedDate(10, "days", "subtract");
 ```
 
 ---
@@ -158,7 +147,8 @@ An object containing:
 ### Example:
 
 ```js
-const longcode = "address: abc123def456ghi789jkl012mno345pqr678stu9, transaction: xyz123abc456def789ghi012jkl345mno678pqr901";
+const longcode =
+    "address: abc123def456ghi789jkl012mno345pqr678stu9, transaction: xyz123abc456def789ghi012jkl345mno678pqr901";
 const parsed = parseCryptoLongcode(longcode);
 
 console.log(parsed.addressHash); // "abc123def456ghi789jkl012mno345pqr678stu9"