@arkyn/shared 3.0.1-beta.143 → 3.0.1-beta.144

package/dist/bundle.js

@@ -27,24 +27,11 @@ class v1 {
     }
   }
   /**
-   * Validates the components of a date (year, month, and day).
+   * Throws if year, month, or day are out of valid range or inconsistent with the calendar.
    *
-   * @param {number} year - The year to validate (must be 4 digits).
-   * @param {number} month - The month to validate (must be between 1 and 12).
-   * @param {number} day - The day to validate (must be between 1 and 31, and valid for the month).
-   *
-   * @throws {Error} "Year should be four digits" - If the year doesn't have exactly 4 digits.
-   * @throws {Error} "Month should be between 1 and 12" - If the month is out of valid range.
-   * @throws {Error} "Day should be between 1 and 31" - If the day is out of valid range.
-   * @throws {Error} Month-specific error - If the day is invalid for the specific month.
-   *
-   * @example
-   * ```typescript
-   * const service = new ValidateDateService();
-   * service.validateDateParts(2024, 2, 29); // Valid leap year date
-   * service.validateDateParts(2023, 2, 29); // Throws error - not a leap year
-   * service.validateDateParts(2024, 4, 31); // Throws error - April has only 30 days
-   * ```
+   * @param year - 4-digit year (1000–9999).
+   * @param month - Month number (1–12).
+   * @param day - Day number (1–31, validated against the specific month).
    */
   validateDateParts(t, e, n) {
     const r = {
@@ -58,26 +45,9 @@ class v1 {
     this.validateDayInMonth(n, e, t);
   }
   /**
-   * Validates that a given format string is supported.
-   *
-   * @param {string} format - The format string to validate.
-   *
-   * @throws {Error} "Invalid input format: {format}" - If the format is not one of the valid formats.
-   *
-   * @remarks
-   * Valid formats are:
-   * - "brazilianDate": DD/MM/YYYY format
-   * - "isoDate": MM-DD-YYYY format
-   * - "timestamp": YYYY-MM-DD format
+   * Throws if `format` is not one of `"brazilianDate"`, `"isoDate"`, or `"timestamp"`.
    *
-   * @example
-   * ```typescript
-   * const service = new ValidateDateService();
-   * service.validateInputFormat("brazilianDate"); // Valid
-   * service.validateInputFormat("isoDate"); // Valid
-   * service.validateInputFormat("timestamp"); // Valid
-   * service.validateInputFormat("customFormat"); // Throws error
-   * ```
+   * @param format - The format string to check.
    */
   validateInputFormat(t) {
     if (!["brazilianDate", "isoDate", "timestamp"].includes(t))

package/dist/formats/formatDate.d.ts

@@ -1,60 +1,24 @@
 /**
- * Formats a date and time string based on the provided input and output formats.
+ * Formats a date (and optional time) string into a custom output format.
+ * All calculations are in UTC+0; use the `timezone` parameter to shift the result.
+ *
+ * @param date - Date string in the format determined by `inputFormat`.
+ * @param time - Optional time string `"HH:mm:ss"` (defaults to `"00:00:00"`).
+ * @param inputFormat - Parsing format:
+ *   - `"brazilianDate"`: DD/MM/YYYY
+ *   - `"isoDate"`: MM-DD-YYYY
+ *   - `"timestamp"`: YYYY-MM-DD
+ * @param outputFormat - Output template using `YYYY`, `MM`, `DD`, `hh`, `mm`, `ss` placeholders.
+ * @param timezone - UTC offset in hours (e.g. `-3` for UTC-3). Defaults to `0`.
+ * @returns The formatted date string.
  *
- * @remarks
- * **Note:** This function works with UTC+0 by default. The returned formatted string is not automatically converted to the machine's local timezone.
- * To adjust the timezone, you must manually specify the `timezone` parameter (e.g., -3 for UTC-3).
- *
- * @param {string[]} dateTime - An array containing the date and optional time.
- *   - The first element is the date string.
- *   - The second element is the time string (default is "00:00:00").
- * @param {"brazilianDate" | "isoDate" | "timestamp"} inputFormat - The format of the input date.
- *   - "brazilianDate": Expects the date in "DD/MM/YYYY" or "D/M/YYYY" format.
- *   - "isoDate": Expects the date in "MM-DD-YYYY" or "M-D-YYYY" format.
- *   - "timestamp": Expects the date in "YYYY-MM-DD" or "YYYY-M-D" format.
- * @param {string} outputFormat - The desired output format for the date.
- *   - Use placeholders like "YYYY", "MM", "DD", "hh", "mm", "ss" to define the format.
- * @param {number} [timezone=0] - The timezone offset in hours to apply to the date.
- *   - Defaults to 0 (UTC).
- *
- * @returns {string} The formatted date string based on the output format.
- *
- * @throws {Error} If the date parts are invalid (e.g., month not between 1-12).
- * @throws {Error} If the date created is invalid.
- *
- * @example
- * Format a Brazilian date to ISO format
- * ```typescript
- * const formattedDate = formatDate(
- *   ["25/12/2023", "15:30:00"],
- *   "brazilianDate",
- *   "YYYY-MM-DD hh:mm",
- * );
- *
- * console.log(formattedDate); // Output: "2023-12-25 15:30"
- * ```
- * @example
- * Format an ISO date to a custom format with timezone adjustment
- * ```typescript
- * const formattedDate = formatDate(
- *   ["2023-12-25", "15:30:00"],
- *   "isoDate",
- *   "DD/MM/YYYY hh:mm",
- *   -3,
- * );
- *
- * console.log(formattedDate); // Output: "25/12/2023 12:30"
- * ```
  * @example
- * Format a timestamp date to a custom format
  * ```typescript
- * const formattedDate = formatDate(
- *   ["2023-12-25", "15:30:00"],
- *   "timestamp",
- *   "MM-DD-YYYY hh:mm:ss",
- * );
+ * formatDate(["25/12/2023", "15:30:00"], "brazilianDate", "YYYY-MM-DD hh:mm");
+ * // "2023-12-25 15:30"
  *
- * console.log(formattedDate); // Output: "12-25-2023 15:30:00"
+ * formatDate(["2023-12-25", "15:30:00"], "timestamp", "DD/MM/YYYY hh:mm", -3);
+ * // "2023-12-25 12:30"
  * ```
  */
 declare function formatDate([date, time]: string[], inputFormat: "brazilianDate" | "isoDate" | "timestamp", outputFormat: string, timezone?: number): string;

package/dist/formats/formatDate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatDate.d.ts","sourceRoot":"","sources":["../../src/formats/formatDate.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,iBAAS,UAAU,CACjB,CAAC,IAAI,EAAE,IAAiB,CAAC,EAAE,MAAM,EAAE,EACnC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,WAAW,EACtD,YAAY,EAAE,MAAM,EACpB,QAAQ,GAAE,MAAU,GACnB,MAAM,CAkCR;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"formatDate.d.ts","sourceRoot":"","sources":["../../src/formats/formatDate.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,iBAAS,UAAU,CACjB,CAAC,IAAI,EAAE,IAAiB,CAAC,EAAE,MAAM,EAAE,EACnC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,WAAW,EACtD,YAAY,EAAE,MAAM,EACpB,QAAQ,GAAE,MAAU,GACnB,MAAM,CAkCR;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/formats/formatDate.js

@@ -13,62 +13,26 @@ function formatDateString(date, format) {
     return format.replace(/YYYY|YY|MM|DD|hh|mm|ss/g, (match) => replacements[match]);
 }
 /**
- * Formats a date and time string based on the provided input and output formats.
+ * Formats a date (and optional time) string into a custom output format.
+ * All calculations are in UTC+0; use the `timezone` parameter to shift the result.
  *
- * @remarks
- * **Note:** This function works with UTC+0 by default. The returned formatted string is not automatically converted to the machine's local timezone.
- * To adjust the timezone, you must manually specify the `timezone` parameter (e.g., -3 for UTC-3).
+ * @param date - Date string in the format determined by `inputFormat`.
+ * @param time - Optional time string `"HH:mm:ss"` (defaults to `"00:00:00"`).
+ * @param inputFormat - Parsing format:
+ *   - `"brazilianDate"`: DD/MM/YYYY
+ *   - `"isoDate"`: MM-DD-YYYY
+ *   - `"timestamp"`: YYYY-MM-DD
+ * @param outputFormat - Output template using `YYYY`, `MM`, `DD`, `hh`, `mm`, `ss` placeholders.
+ * @param timezone - UTC offset in hours (e.g. `-3` for UTC-3). Defaults to `0`.
+ * @returns The formatted date string.
  *
- * @param {string[]} dateTime - An array containing the date and optional time.
- *   - The first element is the date string.
- *   - The second element is the time string (default is "00:00:00").
- * @param {"brazilianDate" | "isoDate" | "timestamp"} inputFormat - The format of the input date.
- *   - "brazilianDate": Expects the date in "DD/MM/YYYY" or "D/M/YYYY" format.
- *   - "isoDate": Expects the date in "MM-DD-YYYY" or "M-D-YYYY" format.
- *   - "timestamp": Expects the date in "YYYY-MM-DD" or "YYYY-M-D" format.
- * @param {string} outputFormat - The desired output format for the date.
- *   - Use placeholders like "YYYY", "MM", "DD", "hh", "mm", "ss" to define the format.
- * @param {number} [timezone=0] - The timezone offset in hours to apply to the date.
- *   - Defaults to 0 (UTC).
- *
- * @returns {string} The formatted date string based on the output format.
- *
- * @throws {Error} If the date parts are invalid (e.g., month not between 1-12).
- * @throws {Error} If the date created is invalid.
- *
- * @example
- * Format a Brazilian date to ISO format
- * ```typescript
- * const formattedDate = formatDate(
- *   ["25/12/2023", "15:30:00"],
- *   "brazilianDate",
- *   "YYYY-MM-DD hh:mm",
- * );
- *
- * console.log(formattedDate); // Output: "2023-12-25 15:30"
- * ```
- * @example
- * Format an ISO date to a custom format with timezone adjustment
- * ```typescript
- * const formattedDate = formatDate(
- *   ["2023-12-25", "15:30:00"],
- *   "isoDate",
- *   "DD/MM/YYYY hh:mm",
- *   -3,
- * );
- *
- * console.log(formattedDate); // Output: "25/12/2023 12:30"
- * ```
  * @example
- * Format a timestamp date to a custom format
  * ```typescript
- * const formattedDate = formatDate(
- *   ["2023-12-25", "15:30:00"],
- *   "timestamp",
- *   "MM-DD-YYYY hh:mm:ss",
- * );
+ * formatDate(["25/12/2023", "15:30:00"], "brazilianDate", "YYYY-MM-DD hh:mm");
+ * // "2023-12-25 15:30"
  *
- * console.log(formattedDate); // Output: "12-25-2023 15:30:00"
+ * formatDate(["2023-12-25", "15:30:00"], "timestamp", "DD/MM/YYYY hh:mm", -3);
+ * // "2023-12-25 12:30"
  * ```
  */
 function formatDate([date, time = "00:00:00"], inputFormat, outputFormat, timezone = 0) {

package/dist/formats/formatJsonObject.d.ts

@@ -6,10 +6,9 @@
  * - If the input is a string that can be parsed as JSON, it will attempt to parse and format it.
  * - Primitive values (e.g., numbers, booleans, null) will be converted to their string representation.
  *
- * @param {any} json - The JSON object or value to format. It can be an object, array, string, or primitive value.
- * @param {number} indentLevel - The current level of indentation to apply. This is used recursively to format nested structures.
- *
- * @returns {string} A formatted string representation of the JSON object.
+ * @param json - The value to format: object, array, string, or primitive.
+ * @param indentLevel - Current indentation depth (used recursively; pass `0` at the top level).
+ * @returns A pretty-printed string representation of the value.
  *
  * @example
  * ```typescript

package/dist/formats/formatJsonObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatJsonObject.d.ts","sourceRoot":"","sources":["../../src/formats/formatJsonObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,QAAA,MAAM,gBAAgB,GAAI,MAAM,GAAG,EAAE,aAAa,MAAM,KAAG,MAuD1D,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"formatJsonObject.d.ts","sourceRoot":"","sources":["../../src/formats/formatJsonObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,QAAA,MAAM,gBAAgB,GAAI,MAAM,GAAG,EAAE,aAAa,MAAM,KAAG,MAuD1D,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/formats/formatJsonObject.js

@@ -6,10 +6,9 @@
  * - If the input is a string that can be parsed as JSON, it will attempt to parse and format it.
  * - Primitive values (e.g., numbers, booleans, null) will be converted to their string representation.
  *
- * @param {any} json - The JSON object or value to format. It can be an object, array, string, or primitive value.
- * @param {number} indentLevel - The current level of indentation to apply. This is used recursively to format nested structures.
- *
- * @returns {string} A formatted string representation of the JSON object.
+ * @param json - The value to format: object, array, string, or primitive.
+ * @param indentLevel - Current indentation depth (used recursively; pass `0` at the top level).
+ * @returns A pretty-printed string representation of the value.
  *
  * @example
  * ```typescript

package/dist/formats/formatJsonString.d.ts

@@ -1,37 +1,21 @@
 type FormatJsonStringFunction = (jsonString: string) => string;
 /**
- * Formats a JSON string into a more readable format.
+ * Parses a JSON string and returns a human-readable pretty-printed representation.
+ * Throws if the input is not valid JSON.
  *
- * This function attempts to parse the provided JSON string into a JavaScript object,
- * and then formats it using the `formatJsonObject` function. If the input string
- * is not a valid JSON, it logs an error to the console and returns an empty string.
- *
- * @param jsonString - The JSON string to be formatted.
- * @returns A formatted JSON string, or an empty string if the input is invalid.
- *
- * @throws Will log an error to the console if the input is not a valid JSON string.
+ * @param jsonString - A valid JSON string to format.
+ * @returns A pretty-printed string representation.
  *
  * @example
  * ```typescript
- * const jsonString = '{"name":"John","age":30,"hobbies":["reading","gaming"]}';
- * const formatted = formatJsonString(jsonString);
- * console.log(formatted);
- * // Output:
+ * formatJsonString('{"name":"John","hobbies":["reading","gaming"]}');
  * // {
  * //   "name": "John",
- * //   "age": 30,
  * //   "hobbies": [
  * //     "reading",
  * //     "gaming"
  * //   ]
  * // }
-
- * const invalidJsonString = '{"name":"John", "age":30,';
- * const formatted = formatJsonString(invalidJsonString);
- * console.log(formatted);
- * // Output:
- * // (Logs "Invalid JSON string: ..." to the console)
- * // ""
  * ```
  */
 declare const formatJsonString: FormatJsonStringFunction;

package/dist/formats/formatJsonString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatJsonString.d.ts","sourceRoot":"","sources":["../../src/formats/formatJsonString.ts"],"names":[],"mappings":"AAEA,KAAK,wBAAwB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,QAAA,MAAM,gBAAgB,EAAE,wBAOvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"formatJsonString.d.ts","sourceRoot":"","sources":["../../src/formats/formatJsonString.ts"],"names":[],"mappings":"AAEA,KAAK,wBAAwB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;AAE/D;;;;;;;;;;;;;;;;;;GAkBG;AAEH,QAAA,MAAM,gBAAgB,EAAE,wBAOvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/formats/formatJsonString.js

@@ -1,37 +1,21 @@
 import { formatJsonObject } from "./formatJsonObject";
 /**
- * Formats a JSON string into a more readable format.
+ * Parses a JSON string and returns a human-readable pretty-printed representation.
+ * Throws if the input is not valid JSON.
  *
- * This function attempts to parse the provided JSON string into a JavaScript object,
- * and then formats it using the `formatJsonObject` function. If the input string
- * is not a valid JSON, it logs an error to the console and returns an empty string.
- *
- * @param jsonString - The JSON string to be formatted.
- * @returns A formatted JSON string, or an empty string if the input is invalid.
- *
- * @throws Will log an error to the console if the input is not a valid JSON string.
+ * @param jsonString - A valid JSON string to format.
+ * @returns A pretty-printed string representation.
  *
  * @example
  * ```typescript
- * const jsonString = '{"name":"John","age":30,"hobbies":["reading","gaming"]}';
- * const formatted = formatJsonString(jsonString);
- * console.log(formatted);
- * // Output:
+ * formatJsonString('{"name":"John","hobbies":["reading","gaming"]}');
  * // {
  * //   "name": "John",
- * //   "age": 30,
  * //   "hobbies": [
  * //     "reading",
  * //     "gaming"
  * //   ]
  * // }
-
- * const invalidJsonString = '{"name":"John", "age":30,';
- * const formatted = formatJsonString(invalidJsonString);
- * console.log(formatted);
- * // Output:
- * // (Logs "Invalid JSON string: ..." to the console)
- * // ""
  * ```
  */
 const formatJsonString = (jsonString) => {

package/dist/formats/formatToCapitalizeFirstWordLetter.d.ts

@@ -1,33 +1,14 @@
 /**
- * Formats a sentence by capitalizing the first letter of each word.
- *
- * This function takes a string and capitalizes the first letter of each word
- * while the remaining letters are lowercase.
+ * Capitalizes the first letter of each word and lowercases the rest.
  * Words are separated by spaces.
  *
- * @param sentence - The sentence to be formatted.
- * @returns The sentence formatted with the first letter of each word capitalized.
+ * @param sentence - The string to format.
+ * @returns The sentence with every word title-cased.
  *
  * @example
  * ```typescript
- * // Basic example
- * formatToCapitalizeFirstWordLetter("hello world");
- * // Returns: "Hello World"
- *
- * // With capitalized text.
- * formatToCapitalizeFirstWordLetter("HELLO WORLD");
- * // Returns: "Hello World"
- *
- * // With mixed text.
- * formatToCapitalizeFirstWordLetter("hELLO WoRLd"); * // Returns: "Hello World"
- *
- * // With multiple words
- * formatToCapitalizeFirstWordLetter("javascript is an amazing language");
- * // Returns: "Javascript is an amazing language"
- *
- * // Empty string
- * formatToCapitalizeFirstWordLetter("");
- * // Returns: ""
+ * formatToCapitalizeFirstWordLetter("hello world");  // "Hello World"
+ * formatToCapitalizeFirstWordLetter("HELLO WORLD");  // "Hello World"
  * ```
  */
 declare function formatToCapitalizeFirstWordLetter(sentence: string): string;

package/dist/formats/formatToCapitalizeFirstWordLetter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToCapitalizeFirstWordLetter.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCapitalizeFirstWordLetter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,iBAAS,iCAAiC,CAAC,QAAQ,EAAE,MAAM,UAU1D;AAED,OAAO,EAAE,iCAAiC,EAAE,CAAC"}
+{"version":3,"file":"formatToCapitalizeFirstWordLetter.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCapitalizeFirstWordLetter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,iBAAS,iCAAiC,CAAC,QAAQ,EAAE,MAAM,UAU1D;AAED,OAAO,EAAE,iCAAiC,EAAE,CAAC"}

package/dist/formats/formatToCapitalizeFirstWordLetter.js

@@ -1,33 +1,14 @@
 /**
- * Formats a sentence by capitalizing the first letter of each word.
- *
- * This function takes a string and capitalizes the first letter of each word
- * while the remaining letters are lowercase.
+ * Capitalizes the first letter of each word and lowercases the rest.
  * Words are separated by spaces.
  *
- * @param sentence - The sentence to be formatted.
- * @returns The sentence formatted with the first letter of each word capitalized.
+ * @param sentence - The string to format.
+ * @returns The sentence with every word title-cased.
  *
  * @example
  * ```typescript
- * // Basic example
- * formatToCapitalizeFirstWordLetter("hello world");
- * // Returns: "Hello World"
- *
- * // With capitalized text.
- * formatToCapitalizeFirstWordLetter("HELLO WORLD");
- * // Returns: "Hello World"
- *
- * // With mixed text.
- * formatToCapitalizeFirstWordLetter("hELLO WoRLd"); * // Returns: "Hello World"
- *
- * // With multiple words
- * formatToCapitalizeFirstWordLetter("javascript is an amazing language");
- * // Returns: "Javascript is an amazing language"
- *
- * // Empty string
- * formatToCapitalizeFirstWordLetter("");
- * // Returns: ""
+ * formatToCapitalizeFirstWordLetter("hello world");  // "Hello World"
+ * formatToCapitalizeFirstWordLetter("HELLO WORLD");  // "Hello World"
  * ```
  */
 function formatToCapitalizeFirstWordLetter(sentence) {

package/dist/formats/formatToCep.d.ts

@@ -5,9 +5,8 @@
  * and attempts to format it as a CEP in the pattern `XXXXX-XXX`.
  * If the input does not match the expected format, an error is thrown.
  *
- * @param {string} value - The input string to be formatted as a CEP, the string must contain 8 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CEP string in the pattern `XXXXX-XXX`.
+ * @param value - Input string with 8 numeric digits (special characters are stripped).
+ * @returns The formatted CEP string in the pattern `XXXXX-XXX`.
  *
  * @throws {Error} If the input does not match the expected CEP format.
  *

package/dist/formats/formatToCep.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToCep.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCep.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ1C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"formatToCep.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCep.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ1C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/formats/formatToCep.js

@@ -6,9 +6,8 @@ import { removeNonNumeric } from "../utilities/removeNonNumeric";
  * and attempts to format it as a CEP in the pattern `XXXXX-XXX`.
  * If the input does not match the expected format, an error is thrown.
  *
- * @param {string} value - The input string to be formatted as a CEP, the string must contain 8 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CEP string in the pattern `XXXXX-XXX`.
+ * @param value - Input string with 8 numeric digits (special characters are stripped).
+ * @returns The formatted CEP string in the pattern `XXXXX-XXX`.
  *
  * @throws {Error} If the input does not match the expected CEP format.
  *

package/dist/formats/formatToCnpj.d.ts

@@ -3,9 +3,8 @@
  *
  * The CNPJ format is: `XX.XXX.XXX/XXXX-XX`, where `X` represents a digit.
  *
- * @param {string} value - The input string to be formatted as a CNPJ, the string must contain 14 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CNPJ string in the pattern `XX.XXX.XXX/XXXX-XX`.
+ * @param value - Input string with 14 numeric digits (special characters are stripped).
+ * @returns The formatted CNPJ string in the pattern `XX.XXX.XXX/XXXX-XX`.
  *
  * @throws {Error} Throws an error if the input does not contain exactly 14 numeric digits.
  *

package/dist/formats/formatToCnpj.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToCnpj.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCnpj.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;GAgBG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"formatToCnpj.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCnpj.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/formats/formatToCnpj.js

@@ -4,9 +4,8 @@ import { removeNonNumeric } from "../utilities/removeNonNumeric";
  *
  * The CNPJ format is: `XX.XXX.XXX/XXXX-XX`, where `X` represents a digit.
  *
- * @param {string} value - The input string to be formatted as a CNPJ, the string must contain 14 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CNPJ string in the pattern `XX.XXX.XXX/XXXX-XX`.
+ * @param value - Input string with 14 numeric digits (special characters are stripped).
+ * @returns The formatted CNPJ string in the pattern `XX.XXX.XXX/XXXX-XX`.
  *
  * @throws {Error} Throws an error if the input does not contain exactly 14 numeric digits.
  *

package/dist/formats/formatToCpf.d.ts

@@ -5,9 +5,8 @@
  * This function ensures the input is cleaned of non-numeric characters and
  * then formats it into the standard CPF format: `XXX.XXX.XXX-XX`.
  *
- * @param {string} value -  The input string to be formatted as a CPF, the string must contain 11 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CPF string.
+ * @param value - Input string with 11 numeric digits (special characters are stripped).
+ * @returns The formatted CPF string in the pattern `XXX.XXX.XXX-XX`.
  *
  * @throws {Error} If the input string does not match the expected CPF format.
  *

package/dist/formats/formatToCpf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToCpf.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCpf.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ1C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"formatToCpf.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCpf.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ1C;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/formats/formatToCpf.js

@@ -6,9 +6,8 @@ import { removeNonNumeric } from "../utilities/removeNonNumeric";
  * This function ensures the input is cleaned of non-numeric characters and
  * then formats it into the standard CPF format: `XXX.XXX.XXX-XX`.
  *
- * @param {string} value -  The input string to be formatted as a CPF, the string must contain 11 numeric digits; special characters will be ignored.
- *
- * @returns {string} The formatted CPF string.
+ * @param value - Input string with 11 numeric digits (special characters are stripped).
+ * @returns The formatted CPF string in the pattern `XXX.XXX.XXX-XX`.
  *
  * @throws {Error} If the input string does not match the expected CPF format.
  *

package/dist/formats/formatToCurrency.d.ts

@@ -1,34 +1,17 @@
 import { countryCurrencies } from "@arkyn/templates";
 type Currencies = keyof typeof countryCurrencies;
 /**
- * Formats a numeric value into a currency string based on the specified currency and configuration.
+ * Formats a number into a locale-aware currency string using `Intl.NumberFormat`.
  *
- * @param {number} value - The numeric value to be formatted.
- * @param {Currencies} currency - The currency code used to determine the formatting style.
- * @param {object} [config] - Optional configuration object.
- * @param {boolean} [config.showPrefix=true] - Determines whether the currency symbol/prefix should be included in the formatted string. Defaults to `true`.
+ * @param value - The numeric value to format.
+ * @param currency - A currency code from `@arkyn/templates` (e.g. `"BRL"`, `"USD"`).
+ * @param config.showPrefix - Whether to include the currency symbol. Defaults to `true`.
+ * @returns The formatted currency string.
  *
- * @returns {string} A formatted currency string. If `config.showPrefix` is `false`, the currency symbol is removed.
- *
- * @example Format a value in USD with prefix
- * ```typescript
- * const formatted = formatToCurrency(1234.56, "USD", { showPrefix: true });
- * console.log(formatted); // "$1,234.56"
- * ```
- * @example Format a value in USD without prefix
- * ```typescript
- * const withoutPrefix = formatToCurrency(1234.56, "USD", { showPrefix: false });
- * console.log(withoutPrefix); // "1,234.56"
- * ```
- * @example Format a value in BRL with prefix
- * ```typescript
- * const formattedBRL = formatToCurrency(1234.56, "BRL", { showPrefix: true });
- * console.log(formattedBRL); // "R$ 1.234,56"
- * ```
- * @example Format a value in BRL without prefix
+ * @example
  * ```typescript
- * const withoutPrefixBRL = formatToCurrency(1234.56, "BRL", { showPrefix: false });
- * console.log(withoutPrefixBRL); // "1.234,56"
+ * formatToCurrency(1234.56, "BRL"); // "R$ 1.234,56"
+ * formatToCurrency(1234.56, "USD", { showPrefix: false }); // "1,234.56"
  * ```
  */
 declare function formatToCurrency(value: number, currency: Currencies, config?: {

package/dist/formats/formatToCurrency.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToCurrency.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCurrency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD,KAAK,UAAU,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,iBAAS,gBAAgB,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,UAAU,EACpB,MAAM,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAChC,MAAM,CAiBR;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"formatToCurrency.d.ts","sourceRoot":"","sources":["../../src/formats/formatToCurrency.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD,KAAK,UAAU,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAEjD;;;;;;;;;;;;;GAaG;AACH,iBAAS,gBAAgB,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,UAAU,EACpB,MAAM,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAChC,MAAM,CAiBR;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/formats/formatToCurrency.js

@@ -1,34 +1,17 @@
 import { countryCurrencies } from "@arkyn/templates";
 import { removeCurrencySymbols } from "../utilities/removeCurrencySymbols";
 /**
- * Formats a numeric value into a currency string based on the specified currency and configuration.
+ * Formats a number into a locale-aware currency string using `Intl.NumberFormat`.
  *
- * @param {number} value - The numeric value to be formatted.
- * @param {Currencies} currency - The currency code used to determine the formatting style.
- * @param {object} [config] - Optional configuration object.
- * @param {boolean} [config.showPrefix=true] - Determines whether the currency symbol/prefix should be included in the formatted string. Defaults to `true`.
+ * @param value - The numeric value to format.
+ * @param currency - A currency code from `@arkyn/templates` (e.g. `"BRL"`, `"USD"`).
+ * @param config.showPrefix - Whether to include the currency symbol. Defaults to `true`.
+ * @returns The formatted currency string.
  *
- * @returns {string} A formatted currency string. If `config.showPrefix` is `false`, the currency symbol is removed.
- *
- * @example Format a value in USD with prefix
- * ```typescript
- * const formatted = formatToCurrency(1234.56, "USD", { showPrefix: true });
- * console.log(formatted); // "$1,234.56"
- * ```
- * @example Format a value in USD without prefix
- * ```typescript
- * const withoutPrefix = formatToCurrency(1234.56, "USD", { showPrefix: false });
- * console.log(withoutPrefix); // "1,234.56"
- * ```
- * @example Format a value in BRL with prefix
- * ```typescript
- * const formattedBRL = formatToCurrency(1234.56, "BRL", { showPrefix: true });
- * console.log(formattedBRL); // "R$ 1.234,56"
- * ```
- * @example Format a value in BRL without prefix
+ * @example
  * ```typescript
- * const withoutPrefixBRL = formatToCurrency(1234.56, "BRL", { showPrefix: false });
- * console.log(withoutPrefixBRL); // "1.234,56"
+ * formatToCurrency(1234.56, "BRL"); // "R$ 1.234,56"
+ * formatToCurrency(1234.56, "USD", { showPrefix: false }); // "1,234.56"
  * ```
  */
 function formatToCurrency(value, currency, config) {