numeric-quantity 3.1.0 → 3.2.0

package/dist/types/constants.d.ts

@@ -1,87 +0,0 @@
-import type { NumericQuantityOptions, RomanNumeralAscii, RomanNumeralUnicode, VulgarFraction } from "./types";
-/**
-* Normalizes non-ASCII decimal digits to ASCII digits.
-* Converts characters from Unicode decimal digit blocks (e.g., Arabic-Indic,
-* Devanagari, Bengali) to their ASCII equivalents (0-9).
-*
-* All current Unicode \p{Nd} blocks are included in decimalDigitBlockStarts.
-*/
-export declare const normalizeDigits: (str: string) => string;
-/**
-* Map of Unicode fraction code points to their ASCII equivalents.
-*/
-export declare const vulgarFractionToAsciiMap: Record<VulgarFraction, `${number}/${number | ""}`>;
-/**
-* Captures the individual elements of a numeric string. Commas and underscores are allowed
-* as separators, as long as they appear between digits and are not consecutive.
-*
-* Capture groups:
-*
-* |  #  |    Description                                   |        Example(s)                                                   |
-* | --- | ------------------------------------------------ | ------------------------------------------------------------------- |
-* | `0` | entire string                                    | `"2 1/3"` from `"2 1/3"`                                            |
-* | `1` | "negative" dash                                  | `"-"` from `"-2 1/3"`                                               |
-* | `2` | whole number or numerator                        | `"2"` from `"2 1/3"`; `"1"` from `"1/3"`                            |
-* | `3` | entire fraction, decimal portion, or denominator | `" 1/3"` from `"2 1/3"`; `".33"` from `"2.33"`; `"/3"` from `"1/3"` |
-*
-* _Capture group 2 may include comma/underscore separators._
-*
-* @example
-*
-* ```ts
-* numericRegex.exec("1")     // [ "1",     "1", null,   null ]
-* numericRegex.exec("1.23")  // [ "1.23",  "1", ".23",  null ]
-* numericRegex.exec("1 2/3") // [ "1 2/3", "1", " 2/3", " 2" ]
-* numericRegex.exec("2/3")   // [ "2/3",   "2", "/3",   null ]
-* numericRegex.exec("2 / 3") // [ "2 / 3", "2", "/ 3",  null ]
-* ```
-*/
-export declare const numericRegex: RegExp;
-/**
-* Same as {@link numericRegex}, but allows (and ignores) trailing invalid characters.
-*/
-export declare const numericRegexWithTrailingInvalid: RegExp;
-/**
-* Captures any Unicode vulgar fractions.
-*/
-export declare const vulgarFractionsRegex: RegExp;
-type RomanNumeralSequenceFragment = `${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}`;
-/**
-* Map of Roman numeral sequences to their decimal equivalents.
-*/
-export declare const romanNumeralValues: { [k in RomanNumeralSequenceFragment]? : number };
-/**
-* Map of Unicode Roman numeral code points to their ASCII equivalents.
-*/
-export declare const romanNumeralUnicodeToAsciiMap: Record<RomanNumeralUnicode, keyof typeof romanNumeralValues>;
-/**
-* Captures all Unicode Roman numeral code points.
-*/
-export declare const romanNumeralUnicodeRegex: RegExp;
-/**
-* Captures a valid Roman numeral sequence.
-*
-* Capture groups:
-*
-* |  #  |  Description    |         Example          |
-* | --- | --------------- | ------------------------ |
-* | `0` |  Entire string  |  "MCCXIV" from "MCCXIV"  |
-* | `1` |  Thousands      |  "M" from "MCCXIV"       |
-* | `2` |  Hundreds       |  "CC" from "MCCXIV"      |
-* | `3` |  Tens           |  "X" from "MCCXIV"       |
-* | `4` |  Ones           |  "IV" from "MCCXIV"      |
-*
-* @example
-*
-* ```ts
-* romanNumeralRegex.exec("M")      // [      "M", "M",   "",  "",   "" ]
-* romanNumeralRegex.exec("XII")    // [    "XII",  "",   "", "X", "II" ]
-* romanNumeralRegex.exec("MCCXIV") // [ "MCCXIV", "M", "CC", "X", "IV" ]
-* ```
-*/
-export declare const romanNumeralRegex: RegExp;
-/**
-* Default options for {@link numericQuantity}.
-*/
-export declare const defaultOptions: Required<NumericQuantityOptions>;
-export {};

package/dist/types/dev.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./constants";
-export * from "./numericQuantity";
-export * from "./parseRomanNumerals";
-export * from "./types";

package/dist/types/numericQuantity.d.ts

@@ -1,12 +0,0 @@
-import type { NumericQuantityOptions } from "./types";
-/**
-* Converts a string to a number, like an enhanced version of `parseFloat`.
-*
-* The string can include mixed numbers, vulgar fractions, or Roman numerals.
-*/
-declare function numericQuantity(quantity: string | number): number;
-declare function numericQuantity(quantity: string | number, options: NumericQuantityOptions & {
-	bigIntOnOverflow: true
-}): number | bigint;
-declare function numericQuantity(quantity: string | number, options?: NumericQuantityOptions): number;
-export { numericQuantity };

package/dist/types/parseRomanNumerals.d.ts

@@ -1,8 +0,0 @@
-/**
-* Converts a string of Roman numerals to a number, like `parseInt`
-* for Roman numerals. Uses modern, strict rules (only 1 to 3999).
-*
-* The string can include ASCII representations of Roman numerals
-* or Unicode Roman numeral code points (`U+2160` through `U+217F`).
-*/
-export declare const parseRomanNumerals: (romanNumerals: string) => number;

package/dist/types/types.d.ts

@@ -1,49 +0,0 @@
-export interface NumericQuantityOptions {
-	/**
-	* Round the result to this many decimal places. Defaults to 3; must
-	* be greater than or equal to zero.
-	*
-	* @default 3
-	*/
-	round?: number | false;
-	/**
-	* Allow and ignore trailing invalid characters _à la_ `parseFloat`.
-	*
-	* @default false
-	*/
-	allowTrailingInvalid?: boolean;
-	/**
-	* Attempt to parse Roman numerals if Arabic numeral parsing fails.
-	*
-	* @default false
-	*/
-	romanNumerals?: boolean;
-	/**
-	* Generates a `bigint` value if the string represents
-	* a valid integer too large for the `number` type.
-	*/
-	bigIntOnOverflow?: boolean;
-	/**
-	* Specifies which character ("." or ",") to treat as the decimal separator.
-	*
-	* @default "."
-	*/
-	decimalSeparator?: "," | ".";
-}
-/**
-* Unicode vulgar fraction code points.
-*/
-export type VulgarFraction = "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞" | "⅟";
-/**
-* Allowable Roman numeral characters (ASCII, uppercase only).
-*/
-export type RomanNumeralAscii = "I" | "V" | "X" | "L" | "C" | "D" | "M";
-/**
-* Unicode Roman numeral code points (uppercase and lowercase,
-* representing 1-12, 50, 100, 500, and 1000).
-*/
-export type RomanNumeralUnicode = "Ⅰ" | "Ⅱ" | "Ⅲ" | "Ⅳ" | "Ⅴ" | "Ⅵ" | "Ⅶ" | "Ⅷ" | "Ⅸ" | "Ⅹ" | "Ⅺ" | "Ⅻ" | "Ⅼ" | "Ⅽ" | "Ⅾ" | "Ⅿ" | "ⅰ" | "ⅱ" | "ⅲ" | "ⅳ" | "ⅴ" | "ⅵ" | "ⅶ" | "ⅷ" | "ⅸ" | "ⅹ" | "ⅺ" | "ⅻ" | "ⅼ" | "ⅽ" | "ⅾ" | "ⅿ";
-/**
-* Union of ASCII and Unicode Roman numeral characters/code points.
-*/
-export type RomanNumeral = RomanNumeralAscii | RomanNumeralUnicode;

package/dist/types-esm/constants.d.mts

@@ -1,87 +0,0 @@
-import type { NumericQuantityOptions, RomanNumeralAscii, RomanNumeralUnicode, VulgarFraction } from "./types.mjs";
-/**
-* Normalizes non-ASCII decimal digits to ASCII digits.
-* Converts characters from Unicode decimal digit blocks (e.g., Arabic-Indic,
-* Devanagari, Bengali) to their ASCII equivalents (0-9).
-*
-* All current Unicode \p{Nd} blocks are included in decimalDigitBlockStarts.
-*/
-export declare const normalizeDigits: (str: string) => string;
-/**
-* Map of Unicode fraction code points to their ASCII equivalents.
-*/
-export declare const vulgarFractionToAsciiMap: Record<VulgarFraction, `${number}/${number | ""}`>;
-/**
-* Captures the individual elements of a numeric string. Commas and underscores are allowed
-* as separators, as long as they appear between digits and are not consecutive.
-*
-* Capture groups:
-*
-* |  #  |    Description                                   |        Example(s)                                                   |
-* | --- | ------------------------------------------------ | ------------------------------------------------------------------- |
-* | `0` | entire string                                    | `"2 1/3"` from `"2 1/3"`                                            |
-* | `1` | "negative" dash                                  | `"-"` from `"-2 1/3"`                                               |
-* | `2` | whole number or numerator                        | `"2"` from `"2 1/3"`; `"1"` from `"1/3"`                            |
-* | `3` | entire fraction, decimal portion, or denominator | `" 1/3"` from `"2 1/3"`; `".33"` from `"2.33"`; `"/3"` from `"1/3"` |
-*
-* _Capture group 2 may include comma/underscore separators._
-*
-* @example
-*
-* ```ts
-* numericRegex.exec("1")     // [ "1",     "1", null,   null ]
-* numericRegex.exec("1.23")  // [ "1.23",  "1", ".23",  null ]
-* numericRegex.exec("1 2/3") // [ "1 2/3", "1", " 2/3", " 2" ]
-* numericRegex.exec("2/3")   // [ "2/3",   "2", "/3",   null ]
-* numericRegex.exec("2 / 3") // [ "2 / 3", "2", "/ 3",  null ]
-* ```
-*/
-export declare const numericRegex: RegExp;
-/**
-* Same as {@link numericRegex}, but allows (and ignores) trailing invalid characters.
-*/
-export declare const numericRegexWithTrailingInvalid: RegExp;
-/**
-* Captures any Unicode vulgar fractions.
-*/
-export declare const vulgarFractionsRegex: RegExp;
-type RomanNumeralSequenceFragment = `${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}` | `${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}${RomanNumeralAscii}`;
-/**
-* Map of Roman numeral sequences to their decimal equivalents.
-*/
-export declare const romanNumeralValues: { [k in RomanNumeralSequenceFragment]? : number };
-/**
-* Map of Unicode Roman numeral code points to their ASCII equivalents.
-*/
-export declare const romanNumeralUnicodeToAsciiMap: Record<RomanNumeralUnicode, keyof typeof romanNumeralValues>;
-/**
-* Captures all Unicode Roman numeral code points.
-*/
-export declare const romanNumeralUnicodeRegex: RegExp;
-/**
-* Captures a valid Roman numeral sequence.
-*
-* Capture groups:
-*
-* |  #  |  Description    |         Example          |
-* | --- | --------------- | ------------------------ |
-* | `0` |  Entire string  |  "MCCXIV" from "MCCXIV"  |
-* | `1` |  Thousands      |  "M" from "MCCXIV"       |
-* | `2` |  Hundreds       |  "CC" from "MCCXIV"      |
-* | `3` |  Tens           |  "X" from "MCCXIV"       |
-* | `4` |  Ones           |  "IV" from "MCCXIV"      |
-*
-* @example
-*
-* ```ts
-* romanNumeralRegex.exec("M")      // [      "M", "M",   "",  "",   "" ]
-* romanNumeralRegex.exec("XII")    // [    "XII",  "",   "", "X", "II" ]
-* romanNumeralRegex.exec("MCCXIV") // [ "MCCXIV", "M", "CC", "X", "IV" ]
-* ```
-*/
-export declare const romanNumeralRegex: RegExp;
-/**
-* Default options for {@link numericQuantity}.
-*/
-export declare const defaultOptions: Required<NumericQuantityOptions>;
-export {};

package/dist/types-esm/dev.d.mts

@@ -1 +0,0 @@
-export {};

package/dist/types-esm/index.d.mts

@@ -1,4 +0,0 @@
-export * from "./constants.mjs";
-export * from "./numericQuantity.mjs";
-export * from "./parseRomanNumerals.mjs";
-export * from "./types.mjs";

package/dist/types-esm/numericQuantity.d.mts

@@ -1,12 +0,0 @@
-import type { NumericQuantityOptions } from "./types.mjs";
-/**
-* Converts a string to a number, like an enhanced version of `parseFloat`.
-*
-* The string can include mixed numbers, vulgar fractions, or Roman numerals.
-*/
-declare function numericQuantity(quantity: string | number): number;
-declare function numericQuantity(quantity: string | number, options: NumericQuantityOptions & {
-	bigIntOnOverflow: true
-}): number | bigint;
-declare function numericQuantity(quantity: string | number, options?: NumericQuantityOptions): number;
-export { numericQuantity };

package/dist/types-esm/parseRomanNumerals.d.mts

@@ -1,8 +0,0 @@
-/**
-* Converts a string of Roman numerals to a number, like `parseInt`
-* for Roman numerals. Uses modern, strict rules (only 1 to 3999).
-*
-* The string can include ASCII representations of Roman numerals
-* or Unicode Roman numeral code points (`U+2160` through `U+217F`).
-*/
-export declare const parseRomanNumerals: (romanNumerals: string) => number;

package/dist/types-esm/types.d.mts

@@ -1,49 +0,0 @@
-export interface NumericQuantityOptions {
-	/**
-	* Round the result to this many decimal places. Defaults to 3; must
-	* be greater than or equal to zero.
-	*
-	* @default 3
-	*/
-	round?: number | false;
-	/**
-	* Allow and ignore trailing invalid characters _à la_ `parseFloat`.
-	*
-	* @default false
-	*/
-	allowTrailingInvalid?: boolean;
-	/**
-	* Attempt to parse Roman numerals if Arabic numeral parsing fails.
-	*
-	* @default false
-	*/
-	romanNumerals?: boolean;
-	/**
-	* Generates a `bigint` value if the string represents
-	* a valid integer too large for the `number` type.
-	*/
-	bigIntOnOverflow?: boolean;
-	/**
-	* Specifies which character ("." or ",") to treat as the decimal separator.
-	*
-	* @default "."
-	*/
-	decimalSeparator?: "," | ".";
-}
-/**
-* Unicode vulgar fraction code points.
-*/
-export type VulgarFraction = "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞" | "⅟";
-/**
-* Allowable Roman numeral characters (ASCII, uppercase only).
-*/
-export type RomanNumeralAscii = "I" | "V" | "X" | "L" | "C" | "D" | "M";
-/**
-* Unicode Roman numeral code points (uppercase and lowercase,
-* representing 1-12, 50, 100, 500, and 1000).
-*/
-export type RomanNumeralUnicode = "Ⅰ" | "Ⅱ" | "Ⅲ" | "Ⅳ" | "Ⅴ" | "Ⅵ" | "Ⅶ" | "Ⅷ" | "Ⅸ" | "Ⅹ" | "Ⅺ" | "Ⅻ" | "Ⅼ" | "Ⅽ" | "Ⅾ" | "Ⅿ" | "ⅰ" | "ⅱ" | "ⅲ" | "ⅳ" | "ⅴ" | "ⅵ" | "ⅶ" | "ⅷ" | "ⅸ" | "ⅹ" | "ⅺ" | "ⅻ" | "ⅼ" | "ⅽ" | "ⅾ" | "ⅿ";
-/**
-* Union of ASCII and Unicode Roman numeral characters/code points.
-*/
-export type RomanNumeral = RomanNumeralAscii | RomanNumeralUnicode;