numeric-quantity 2.0.0 → 2.1.0

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

@@ -0,0 +1,78 @@
+import type { NumericQuantityOptions, RomanNumeralAscii, RomanNumeralUnicode, VulgarFraction } from "./types.mjs";
+/**
+* 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.
+*
+* 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

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

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

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

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

@@ -0,0 +1,13 @@
+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): 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

@@ -0,0 +1,8 @@
+/**
+* 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

@@ -0,0 +1,43 @@
+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;
+}
+/**
+* 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/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "name": "numeric-quantity",
   "author": "Jake Boone <jakeboone02@gmail.com>",
@@ -12,12 +12,17 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./dist/numeric-quantity.d.ts",
-      "import": "./dist/numeric-quantity.mjs",
-      "require": "./dist/cjs/index.js"
+      "import": {
+        "types": "./dist/types-esm/index.d.mts",
+        "default": "./dist/numeric-quantity.mjs"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
-  "types": "./dist/numeric-quantity.d.ts",
+  "types": "./dist/types/index.d.ts",
   "unpkg": "./dist/numeric-quantity.umd.min.js",
   "bugs": {
     "url": "https://github.com/jakeboone02/numeric-quantity/issues"
@@ -37,28 +42,29 @@
     "numerals"
   ],
   "scripts": {
-    "start": "vite",
-    "build": "tsup",
-    "test": "jest",
-    "watch": "jest --watch",
+    "start": "bun --hot ./main.html",
+    "build": "bunx --bun tsup",
+    "docs": "typedoc",
+    "test": "bun test",
+    "watch": "bun test --watch",
+    "lint": "bunx oxlint@latest --format=github",
     "publish:npm": "np",
-    "pretty-print": "prettier --write *.{mjs,js,ts,json} src/*.*"
+    "codesandbox-ci": "bash .codesandbox/ci.sh",
+    "pretty-print": "prettier --write '*.{html,json,ts}' 'src/*.*'"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.2",
-    "@types/node": "^20.3.0",
-    "gh-pages": "^5.0.0",
-    "jest": "^29.5.0",
-    "np": "^8.0.3",
-    "prettier": "^2.8.8",
-    "prettier-plugin-organize-imports": "^3.2.2",
-    "ts-jest": "^29.1.0",
-    "tsup": "^6.7.0",
-    "typescript": "^5.1.3",
-    "vite": "^4.3.9"
+    "@jakeboone02/generate-dts": "0.1.1",
+    "@types/bun": "^1.2.8",
+    "@types/node": "^22.13.14",
+    "@types/web": "^0.0.214",
+    "np": "^10.2.0",
+    "prettier": "3.5.3",
+    "prettier-plugin-organize-imports": "4.1.0",
+    "tsup": "^8.4.0",
+    "typedoc": "^0.28.1",
+    "typescript": "^5.8.2"
   },
   "engines": {
     "node": ">=16"
-  },
-  "packageManager": "yarn@3.6.0"
+  }
 }

package/dist/numeric-quantity.d.ts

@@ -1,174 +0,0 @@
-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;
-}
-/**
- * Unicode vulgar fraction code points
- */
-type VulgarFraction = '¼' | '½' | '¾' | '⅐' | '⅑' | '⅒' | '⅓' | '⅔' | '⅕' | '⅖' | '⅗' | '⅘' | '⅙' | '⅚' | '⅛' | '⅜' | '⅝' | '⅞' | '⅟';
-/**
- * Allowable Roman numeral characters (ASCII, uppercase only)
- */
-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)
- */
-type RomanNumeralUnicode = 'Ⅰ' | 'Ⅱ' | 'Ⅲ' | 'Ⅳ' | 'Ⅴ' | 'Ⅵ' | 'Ⅶ' | 'Ⅷ' | 'Ⅸ' | 'Ⅹ' | 'Ⅺ' | 'Ⅻ' | 'Ⅼ' | 'Ⅽ' | 'Ⅾ' | 'Ⅿ' | 'ⅰ' | 'ⅱ' | 'ⅲ' | 'ⅳ' | 'ⅴ' | 'ⅵ' | 'ⅶ' | 'ⅷ' | 'ⅸ' | 'ⅹ' | 'ⅺ' | 'ⅻ' | 'ⅼ' | 'ⅽ' | 'ⅾ' | 'ⅿ';
-/**
- * Union of ASCII and Unicode Roman numeral characters/code points
- */
-type RomanNumeral = RomanNumeralAscii | RomanNumeralUnicode;
-
-/**
- * Map of Unicode fraction code points to their ASCII equivalents
- */
-declare const vulgarFractionToAsciiMap: Record<VulgarFraction, string>;
-/**
- * Captures the individual elements of a numeric string.
- *
- * Capture groups:
- *
- *     +=====+====================+========================+
- *     |  #  |    Description     |        Example         |
- *     +=====+====================+========================+
- *     |  0  |  entire string     |  "2 1/3" from "2 1/3"  |
- *     +-----+--------------------+------------------------+
- *     |  1  |  "negative" dash   |  "-" from "-2 1/3"     |
- *     +-----+--------------------+------------------------+
- *     |  2  |  the whole number  |  "2" from "2 1/3"      |
- *     |     |  - OR -            |                        |
- *     |     |  the numerator     |  "1" from "1/3"        |
- *     |     +                    +                        |
- *     | (This may include comma/underscore separators)    |
- *     +-----+--------------------+------------------------+
- *     |  3  |  entire fraction   |  " 1/3" from "2 1/3"   |
- *     |     |  - OR -            |                        |
- *     |     |  decimal portion   |  ".33" from "2.33"     |
- *     |     |  - OR -            |                        |
- *     |     |  denominator       |  "/3" from "1/3"       |
- *     +=====+====================+========================+
- *
- * @example
- *     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 ]
- */
-declare const numericRegex: RegExp;
-/**
- * Same as `numericRegex`, but allows/ignores trailing invalid characters.
- */
-declare const numericRegexWithTrailingInvalid: RegExp;
-/**
- * Captures any Unicode vulgar fractions
- */
-declare const vulgarFractionsRegex: RegExp;
-declare const romanNumeralValues: {
-    MMM: number;
-    MM: number;
-    M: number;
-    CM: number;
-    DCCC: number;
-    DCC: number;
-    DC: number;
-    D: number;
-    CD: number;
-    CCC: number;
-    CC: number;
-    C: number;
-    XC: number;
-    LXXX: number;
-    LXX: number;
-    LX: number;
-    L: number;
-    XL: number;
-    XXX: number;
-    XX: number;
-    XII: number;
-    XI: number;
-    X: number;
-    IX: number;
-    VIII: number;
-    VII: number;
-    VI: number;
-    V: number;
-    IV: number;
-    III: number;
-    II: number;
-    I: number;
-};
-/**
- * Map of Unicode Roman numeral code points to their ASCII equivalents
- */
-declare const romanNumeralUnicodeToAsciiMap: Record<RomanNumeralUnicode, keyof typeof romanNumeralValues>;
-/**
- * Captures all Unicode Roman numeral code points
- */
-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
- *     romanNumeralRegex.exec("M")      // [      "M", "M",   "",  "",   "" ]
- *     romanNumeralRegex.exec("XII")    // [    "XII",  "",   "", "X", "II" ]
- *     romanNumeralRegex.exec("MCCXIV") // [ "MCCXIV", "M", "CC", "X", "IV" ]
- */
-declare const romanNumeralRegex: RegExp;
-declare const defaultOptions: {
-    round: number;
-    allowTrailingInvalid: false;
-    romanNumerals: false;
-};
-
-/**
- * Converts a string to a number, like an enhanced version of `parseFloat`.
- *
- * The string can include mixed numbers, vulgar fractions, or Roman numerals.
- */
-declare const numericQuantity: (quantity: string | number, options?: NumericQuantityOptions) => number;
-
-/**
- * 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`).
- */
-declare const parseRomanNumerals: (romanNumerals: string) => number;
-
-export { NumericQuantityOptions, RomanNumeral, RomanNumeralAscii, RomanNumeralUnicode, VulgarFraction, defaultOptions, numericQuantity, numericRegex, numericRegexWithTrailingInvalid, parseRomanNumerals, romanNumeralRegex, romanNumeralUnicodeRegex, romanNumeralUnicodeToAsciiMap, romanNumeralValues, vulgarFractionToAsciiMap, vulgarFractionsRegex };