format-quantity 3.1.0 → 3.2.0

package/dist/format-quantity.mjs

@@ -1,5 +1,4 @@
 import { numericQuantity } from "numeric-quantity";
-
 //#region src/constants.ts
 /**
 * Default tolerance used by {@link formatQuantity} when determining if a number
@@ -9,16 +8,18 @@ const defaultTolerance = .0075;
 /**
 * Default options for {@link formatQuantity}.
 */
-const defaultOptions = {
+const defaultOptions = Object.freeze({
 	vulgarFractions: false,
 	tolerance: defaultTolerance,
 	fractionSlash: false,
-	romanNumerals: false
-};
+	romanNumerals: false,
+	zeroFormat: "",
+	allowTrailingInvalid: true
+});
 /**
 * Map of vulgar fractions to their traditional ASCII equivalents.
 */
-const vulgarToAsciiMap = {
+const vulgarToAsciiMap = Object.freeze({
 	"¼": "1/4",
 	"½": "1/2",
 	"¾": "3/4",
@@ -37,59 +38,46 @@ const vulgarToAsciiMap = {
 	"⅜": "3/8",
 	"⅝": "5/8",
 	"⅞": "7/8"
-};
+});
 /**
-* Map of "close enough" decimal values to the {@link VulgarFraction} or
-* {@link Sixteenth} fraction string matches.
+* Map of "close enough" values to the {@link VulgarFraction} or {@link Sixteenth} fraction
+* string matches. The value +/- the `tolerance` option (or {@link defaultTolerance} if not
+* specified) is considered close enough to match the fraction.
 */
-const fractionDecimalMatches = [
-	[.33, "⅓"],
-	[.66, "⅔"],
-	[.2, "⅕"],
-	[.4, "⅖"],
-	[.6, "⅗"],
-	[.8, "⅘"],
-	[.166, "⅙"],
-	[.833, "⅚"],
-	[.143, "⅐"],
-	[.111, "⅑"],
-	[.1, "⅒"],
-	[.125, "⅛"],
-	[.25, "¼"],
-	[.375, "⅜"],
-	[.5, "½"],
-	[.625, "⅝"],
-	[.75, "¾"],
-	[.875, "⅞"],
-	[.0625, "1/16"],
-	[.1875, "3/16"],
-	[.3125, "5/16"],
-	[.4375, "7/16"],
-	[.5625, "9/16"],
-	[.6875, "11/16"],
-	[.8125, "13/16"],
-	[.9375, "15/16"]
-];
-
+const fractionDecimalMatches = Object.freeze([
+	[1 / 16, "1/16"],
+	[1 / 10, "⅒"],
+	[1 / 9, "⅑"],
+	[1 / 8, "⅛"],
+	[1 / 7, "⅐"],
+	[1 / 6, "⅙"],
+	[3 / 16, "3/16"],
+	[1 / 5, "⅕"],
+	[1 / 4, "¼"],
+	[5 / 16, "5/16"],
+	[1 / 3, "⅓"],
+	[3 / 8, "⅜"],
+	[2 / 5, "⅖"],
+	[7 / 16, "7/16"],
+	[1 / 2, "½"],
+	[9 / 16, "9/16"],
+	[3 / 5, "⅗"],
+	[5 / 8, "⅝"],
+	[2 / 3, "⅔"],
+	[11 / 16, "11/16"],
+	[3 / 4, "¾"],
+	[4 / 5, "⅘"],
+	[13 / 16, "13/16"],
+	[5 / 6, "⅚"],
+	[7 / 8, "⅞"],
+	[15 / 16, "15/16"]
+].map((entry) => Object.freeze(entry)));
 //#endregion
 //#region src/formatQuantity.ts
-/**
-* Determines if two numbers are close enough to consider
-* them equal for the purposes of this package.
-*/
-const closeEnough = (n1, n2, tolerance) => Math.abs(n1 - n2) < tolerance;
 const superscriptDigits = "⁰¹²³⁴⁵⁶⁷⁸⁹";
 const subscriptDigits = "₀₁₂₃₄₅₆₇₈₉";
-const toSuperscript = (s) => {
-	let r = "";
-	for (let i = 0; i < s.length; i++) r += superscriptDigits[+s[i]];
-	return r;
-};
-const toSubscript = (s) => {
-	let r = "";
-	for (let i = 0; i < s.length; i++) r += subscriptDigits[+s[i]];
-	return r;
-};
+const toSuperscript = (s) => [...s].map((c) => superscriptDigits[+c]).join("");
+const toSubscript = (s) => [...s].map((c) => subscriptDigits[+c]).join("");
 /**
 * Applies the `vulgarFractions` or `fractionSlash` options as necessary.
 */
@@ -103,13 +91,25 @@ const getFraction = (vulgarFractionOrSixteenth, { fractionSlash, vulgarFractions
 	return plainFraction;
 };
 /**
+* Only `false` (matching disabled) or a non-negative number is a valid
+* `tolerance`. Everything else—negative numbers, `NaN`, non-numbers,
+* `null`, `undefined`—resolves to {@link defaultTolerance}.
+*/
+const isValidTolerance = (tolerance) => tolerance === false || typeof tolerance === "number" && tolerance >= 0;
+/**
 * Merges options object with default options, converting boolean to object if necessary.
 */
-const normalizeOptions = (options) => ({
-	...defaultOptions,
-	...typeof options === "boolean" ? { vulgarFractions: options } : options
-});
-const romanNumeralValueKey = [
+const normalizeOptions = (options) => {
+	const opts = {
+		...defaultOptions,
+		...typeof options === "boolean" ? { vulgarFractions: options } : typeof options === "object" && options !== null ? options : {}
+	};
+	if (!isValidTolerance(opts.tolerance)) opts.tolerance = defaultOptions.tolerance;
+	if (typeof opts.zeroFormat !== "string") opts.zeroFormat = defaultOptions.zeroFormat;
+	if (opts.allowTrailingInvalid !== false) opts.allowTrailingInvalid = true;
+	return opts;
+};
+const romanNumeralsByPlace = [
 	"",
 	"C",
 	"CC",
@@ -142,16 +142,17 @@ const romanNumeralValueKey = [
 	"IX"
 ];
 /**
-* Formats a number as Roman numerals. The number must be between
-* 1 and 3999, inclusive.
+* Formats a number or bigint as Roman numerals. The number must be between
+* 1 and 3999, inclusive; any other value—including non-numbers,
+* `NaN`, and non-finite numbers—yields `null`.
 */
-const formatRomanNumerals = (qty) => {
-	if (typeof qty !== "number" || isNaN(qty)) return null;
-	if (qty < 1 || qty >= 4e3) return "";
+const formatRomanNumerals = (quantity) => {
+	if (typeof quantity !== "number" && typeof quantity !== "bigint" || !(quantity >= 1 && quantity < 4e3)) return null;
+	const qty = Number(quantity);
 	const digits = `${Math.floor(qty)}`.split("");
 	let roman = "";
 	let i = 3;
-	while (i--) roman = `${romanNumeralValueKey[+digits.pop() + i * 10] || ""}${roman}`;
+	while (i--) roman = `${romanNumeralsByPlace[+digits.pop() + i * 10] || ""}${roman}`;
 	return `${Array(+digits.join("") + 1).join("M")}${roman}`;
 };
 /**
@@ -161,29 +162,47 @@ const formatRomanNumerals = (qty) => {
 * like "½", pass `true` as the second argument. For other options
 * see {@link FormatQuantityOptions}.
 */
-const formatQuantity = (qty, options = defaultOptions) => {
-	const qtyAsNumber = typeof qty === "string" ? numericQuantity(qty, {
-		round: false,
-		allowTrailingInvalid: true
+const formatQuantity = (qty, options) => {
+	if (typeof qty !== "number" && typeof qty !== "string" && typeof qty !== "bigint") return null;
+	const opts = normalizeOptions(options);
+	const qtyAsNumber = typeof qty !== "number" && typeof qty !== "bigint" ? numericQuantity(qty, {
+		allowTrailingInvalid: opts.allowTrailingInvalid,
+		romanNumerals: opts.romanNumerals,
+		bigIntOnOverflow: true,
+		round: false
 	}) : qty;
-	if (isNaN(qtyAsNumber) || qtyAsNumber === null) return null;
-	if (qtyAsNumber === 0) return "";
-	const opts = normalizeOptions(options ?? defaultOptions);
+	if (typeof qtyAsNumber === "number" && isNaN(qtyAsNumber)) return null;
+	if (Number(qtyAsNumber) === 0) return opts.zeroFormat;
 	if (opts.romanNumerals) return formatRomanNumerals(qtyAsNumber);
-	const absoluteValue = Math.abs(qtyAsNumber);
-	const flooredAbsVal = Math.floor(absoluteValue);
-	const sign = qtyAsNumber < 0 ? "-" : "";
-	const wholeStr = flooredAbsVal === 0 ? "" : `${flooredAbsVal}`;
-	const decimalValue = absoluteValue - flooredAbsVal;
+	const absoluteValue = typeof qtyAsNumber === "bigint" ? qtyAsNumber < 0n ? -qtyAsNumber : qtyAsNumber : Math.abs(qtyAsNumber);
+	const flooredAbsVal = typeof absoluteValue === "bigint" ? absoluteValue : Math.floor(absoluteValue);
+	const wholeNumberStr = `${flooredAbsVal || ""}`;
+	const decimalValue = typeof absoluteValue === "bigint" ? 0 : absoluteValue - flooredAbsVal;
 	if (decimalValue === 0) return `${qtyAsNumber}`;
-	for (const [num, vf] of fractionDecimalMatches) if (closeEnough(decimalValue, num, opts.tolerance)) {
-		const fraction = getFraction(vf, opts);
+	let closestMatch = null;
+	let closestMatchDiff = Infinity;
+	if (opts.tolerance !== false) for (const [num, vf] of fractionDecimalMatches) {
+		const diff = Math.abs(decimalValue - num);
+		if (diff < opts.tolerance || diff === 0) {
+			if (diff === 0) {
+				closestMatch = vf;
+				break;
+			}
+			if (diff < closestMatchDiff) {
+				closestMatch = vf;
+				closestMatchDiff = diff;
+			}
+		}
+	}
+	if (closestMatch) {
+		const fraction = getFraction(closestMatch, opts);
 		const isVulgar = fraction in vulgarToAsciiMap;
-		return `${sign}${wholeStr}${wholeStr ? opts.separator ?? (isVulgar ? "" : " ") : ""}${fraction}`;
+		const sep = wholeNumberStr ? opts.separator ?? (isVulgar ? "" : " ") : "";
+		return `${qtyAsNumber < 0 ? "-" : ""}${wholeNumberStr}${sep}${fraction}`;
 	}
 	return `${qtyAsNumber}`;
 };
-
 //#endregion
 export { defaultOptions, defaultTolerance, formatQuantity, formatRomanNumerals, fractionDecimalMatches, vulgarToAsciiMap };
+
 //# sourceMappingURL=format-quantity.mjs.map

package/dist/format-quantity.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"format-quantity.mjs","names":[],"sources":["../src/constants.ts","../src/formatQuantity.ts"],"sourcesContent":["import type {\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Default tolerance used by {@link formatQuantity} when determining if a number\n * is close enough to a fraction value to be considered equivalent.\n */\nexport const defaultTolerance = 0.0075 as const;\n\n/**\n * Default options for {@link formatQuantity}.\n */\nexport const defaultOptions: ResolvedFormatQuantityOptions = {\n  vulgarFractions: false,\n  tolerance: defaultTolerance,\n  fractionSlash: false,\n  romanNumerals: false,\n} as const;\n\n/**\n * Map of vulgar fractions to their traditional ASCII equivalents.\n */\nexport const vulgarToAsciiMap: Record<VulgarFraction, SimpleFraction> = {\n  '¼': '1/4',\n  '½': '1/2',\n  '¾': '3/4',\n  '⅐': '1/7',\n  '⅑': '1/9',\n  '⅒': '1/10',\n  '⅓': '1/3',\n  '⅔': '2/3',\n  '⅕': '1/5',\n  '⅖': '2/5',\n  '⅗': '3/5',\n  '⅘': '4/5',\n  '⅙': '1/6',\n  '⅚': '5/6',\n  '⅛': '1/8',\n  '⅜': '3/8',\n  '⅝': '5/8',\n  '⅞': '7/8',\n} as const;\n\n/**\n * Map of \"close enough\" decimal values to the {@link VulgarFraction} or\n * {@link Sixteenth} fraction string matches.\n */\nexport const fractionDecimalMatches: [number, VulgarFraction | Sixteenth][] = [\n  [0.33, '⅓'],\n  [0.66, '⅔'],\n  [0.2, '⅕'],\n  [0.4, '⅖'],\n  [0.6, '⅗'],\n  [0.8, '⅘'],\n  [0.166, '⅙'],\n  [0.833, '⅚'],\n  [0.143, '⅐'],\n  [0.111, '⅑'],\n  [0.1, '⅒'],\n  [0.125, '⅛'],\n  [0.25, '¼'],\n  [0.375, '⅜'],\n  [0.5, '½'],\n  [0.625, '⅝'],\n  [0.75, '¾'],\n  [0.875, '⅞'],\n  [0.0625, '1/16'],\n  [0.1875, '3/16'],\n  [0.3125, '5/16'],\n  [0.4375, '7/16'],\n  [0.5625, '9/16'],\n  [0.6875, '11/16'],\n  [0.8125, '13/16'],\n  [0.9375, '15/16'],\n] as const;\n","import { numericQuantity } from 'numeric-quantity';\nimport {\n  defaultOptions,\n  fractionDecimalMatches,\n  vulgarToAsciiMap,\n} from './constants';\nimport type {\n  FormatQuantity,\n  FormatQuantityOptions,\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Determines if two numbers are close enough to consider\n * them equal for the purposes of this package.\n */\nconst closeEnough = (n1: number, n2: number, tolerance: number) =>\n  Math.abs(n1 - n2) < tolerance;\n\nconst superscriptDigits = '⁰¹²³⁴⁵⁶⁷⁸⁹';\nconst subscriptDigits = '₀₁₂₃₄₅₆₇₈₉';\n\nconst toSuperscript = (s: string) => {\n  let r = '';\n  for (let i = 0; i < s.length; i++) r += superscriptDigits[+s[i]];\n  return r;\n};\nconst toSubscript = (s: string) => {\n  let r = '';\n  for (let i = 0; i < s.length; i++) r += subscriptDigits[+s[i]];\n  return r;\n};\n\n/**\n * Applies the `vulgarFractions` or `fractionSlash` options as necessary.\n */\nconst getFraction = (\n  vulgarFractionOrSixteenth: VulgarFraction | Sixteenth,\n  { fractionSlash, vulgarFractions }: FormatQuantityOptions\n) => {\n  if (vulgarFractions) {\n    return vulgarFractionOrSixteenth;\n  }\n\n  const plainFraction: SimpleFraction =\n    vulgarToAsciiMap[vulgarFractionOrSixteenth as VulgarFraction] ??\n    vulgarFractionOrSixteenth;\n\n  if (fractionSlash) {\n    const [num, den] = plainFraction.split('/');\n    return `${toSuperscript(num)}⁄${toSubscript(den)}`;\n  }\n\n  return plainFraction;\n};\n\n/**\n * Merges options object with default options, converting boolean to object if necessary.\n */\nconst normalizeOptions = (\n  options: Parameters<FormatQuantity>[1]\n): ResolvedFormatQuantityOptions => ({\n  ...defaultOptions,\n  ...(typeof options === 'boolean' ? { vulgarFractions: options } : options),\n});\n\n// prettier-ignore\nconst romanNumeralValueKey = [\n  \"\", \"C\", \"CC\", \"CCC\", \"CD\", \"D\", \"DC\", \"DCC\", \"DCCC\", \"CM\",\n  \"\", \"X\", \"XX\", \"XXX\", \"XL\", \"L\", \"LX\", \"LXX\", \"LXXX\", \"XC\",\n  \"\", \"I\", \"II\", \"III\", \"IV\", \"V\", \"VI\", \"VII\", \"VIII\", \"IX\",\n] as const;\n\n/**\n * Formats a number as Roman numerals. The number must be between\n * 1 and 3999, inclusive.\n */\nexport const formatRomanNumerals = (qty: number): string | null => {\n  if (typeof qty !== 'number' || isNaN(qty)) {\n    return null;\n  }\n\n  if (qty < 1 || qty >= 4000) {\n    return '';\n  }\n\n  const floored = Math.floor(qty);\n\n  const digits = `${floored}`.split('');\n  let roman = '';\n  let i = 3;\n  while (i--) {\n    roman = `${romanNumeralValueKey[+digits.pop()! + i * 10] || ''}${roman}`;\n  }\n\n  return `${Array(+digits.join('') + 1).join('M')}${roman}`;\n};\n\n/**\n * Formats a number (or string that appears to be a number)\n * as one would see it written in imperial measurements, e.g.\n * \"1 1/2\" instead of \"1.5\". To use vulgar fraction characters\n * like \"½\", pass `true` as the second argument. For other options\n * see {@link FormatQuantityOptions}.\n */\nexport const formatQuantity: FormatQuantity = (\n  qty,\n  options = defaultOptions\n) => {\n  const qtyAsNumber =\n    typeof qty === 'string'\n      ? numericQuantity(qty, { round: false, allowTrailingInvalid: true })\n      : qty;\n\n  // Return `null` if input is not number-like.\n  if (isNaN(qtyAsNumber) || qtyAsNumber === null) {\n    return null;\n  }\n\n  // Return an empty string if the value is zero.\n  // TODO: Consider a `zeroDisplay` option (e.g. `{ zeroDisplay: \"0\" }`) so\n  // callers outside the recipe-ingredient use case can get \"0\" instead of \"\".\n  if (qtyAsNumber === 0) {\n    return '';\n  }\n\n  // The default options parameter in the function signature only takes effect\n  // if the parameter is `undefined`. The nullish coalescing operator below\n  // covers the `null` case.\n  const opts = normalizeOptions(options ?? defaultOptions);\n\n  if (opts.romanNumerals) {\n    return formatRomanNumerals(qtyAsNumber);\n  }\n\n  const absoluteValue = Math.abs(qtyAsNumber);\n  const flooredAbsVal = Math.floor(absoluteValue);\n  const sign = qtyAsNumber < 0 ? '-' : '';\n  const wholeStr = flooredAbsVal === 0 ? '' : `${flooredAbsVal}`;\n  const decimalValue = absoluteValue - flooredAbsVal;\n\n  // For integers just return the given value as a string.\n  if (decimalValue === 0) {\n    return `${qtyAsNumber}`;\n  }\n\n  for (const [num, vf] of fractionDecimalMatches) {\n    if (closeEnough(decimalValue, num, opts.tolerance)) {\n      const fraction = getFraction(vf, opts);\n      const isVulgar = fraction in vulgarToAsciiMap;\n      const sep = wholeStr\n        ? (opts.separator ?? (isVulgar ? '' : ' '))\n        : '';\n      return `${sign}${wholeStr}${sep}${fraction}`;\n    }\n  }\n\n  return `${qtyAsNumber}`;\n};\n"],"mappings":";;;;;;;AAWA,MAAa,mBAAmB;;;;AAKhC,MAAa,iBAAgD;CAC3D,iBAAiB;CACjB,WAAW;CACX,eAAe;CACf,eAAe;CAChB;;;;AAKD,MAAa,mBAA2D;CACtE,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACN;;;;;AAMD,MAAa,yBAAiE;CAC5E,CAAC,KAAM,IAAI;CACX,CAAC,KAAM,IAAI;CACX,CAAC,IAAK,IAAI;CACV,CAAC,IAAK,IAAI;CACV,CAAC,IAAK,IAAI;CACV,CAAC,IAAK,IAAI;CACV,CAAC,MAAO,IAAI;CACZ,CAAC,MAAO,IAAI;CACZ,CAAC,MAAO,IAAI;CACZ,CAAC,MAAO,IAAI;CACZ,CAAC,IAAK,IAAI;CACV,CAAC,MAAO,IAAI;CACZ,CAAC,KAAM,IAAI;CACX,CAAC,MAAO,IAAI;CACZ,CAAC,IAAK,IAAI;CACV,CAAC,MAAO,IAAI;CACZ,CAAC,KAAM,IAAI;CACX,CAAC,MAAO,IAAI;CACZ,CAAC,OAAQ,OAAO;CAChB,CAAC,OAAQ,OAAO;CAChB,CAAC,OAAQ,OAAO;CAChB,CAAC,OAAQ,OAAO;CAChB,CAAC,OAAQ,OAAO;CAChB,CAAC,OAAQ,QAAQ;CACjB,CAAC,OAAQ,QAAQ;CACjB,CAAC,OAAQ,QAAQ;CAClB;;;;;;;;AC3DD,MAAM,eAAe,IAAY,IAAY,cAC3C,KAAK,IAAI,KAAK,GAAG,GAAG;AAEtB,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB;AAExB,MAAM,iBAAiB,MAAc;CACnC,IAAI,IAAI;AACR,MAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,IAAK,MAAK,kBAAkB,CAAC,EAAE;AAC7D,QAAO;;AAET,MAAM,eAAe,MAAc;CACjC,IAAI,IAAI;AACR,MAAK,IAAI,IAAI,GAAG,IAAI,EAAE,QAAQ,IAAK,MAAK,gBAAgB,CAAC,EAAE;AAC3D,QAAO;;;;;AAMT,MAAM,eACJ,2BACA,EAAE,eAAe,sBACd;AACH,KAAI,gBACF,QAAO;CAGT,MAAM,gBACJ,iBAAiB,8BACjB;AAEF,KAAI,eAAe;EACjB,MAAM,CAAC,KAAK,OAAO,cAAc,MAAM,IAAI;AAC3C,SAAO,GAAG,cAAc,IAAI,CAAC,GAAG,YAAY,IAAI;;AAGlD,QAAO;;;;;AAMT,MAAM,oBACJ,aACmC;CACnC,GAAG;CACH,GAAI,OAAO,YAAY,YAAY,EAAE,iBAAiB,SAAS,GAAG;CACnE;AAGD,MAAM,uBAAuB;CAC3B;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;CACtD;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;CACtD;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;CACvD;;;;;AAMD,MAAa,uBAAuB,QAA+B;AACjE,KAAI,OAAO,QAAQ,YAAY,MAAM,IAAI,CACvC,QAAO;AAGT,KAAI,MAAM,KAAK,OAAO,IACpB,QAAO;CAKT,MAAM,SAAS,GAFC,KAAK,MAAM,IAAI,GAEH,MAAM,GAAG;CACrC,IAAI,QAAQ;CACZ,IAAI,IAAI;AACR,QAAO,IACL,SAAQ,GAAG,qBAAqB,CAAC,OAAO,KAAK,GAAI,IAAI,OAAO,KAAK;AAGnE,QAAO,GAAG,MAAM,CAAC,OAAO,KAAK,GAAG,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG;;;;;;;;;AAUpD,MAAa,kBACX,KACA,UAAU,mBACP;CACH,MAAM,cACJ,OAAO,QAAQ,WACX,gBAAgB,KAAK;EAAE,OAAO;EAAO,sBAAsB;EAAM,CAAC,GAClE;AAGN,KAAI,MAAM,YAAY,IAAI,gBAAgB,KACxC,QAAO;AAMT,KAAI,gBAAgB,EAClB,QAAO;CAMT,MAAM,OAAO,iBAAiB,WAAW,eAAe;AAExD,KAAI,KAAK,cACP,QAAO,oBAAoB,YAAY;CAGzC,MAAM,gBAAgB,KAAK,IAAI,YAAY;CAC3C,MAAM,gBAAgB,KAAK,MAAM,cAAc;CAC/C,MAAM,OAAO,cAAc,IAAI,MAAM;CACrC,MAAM,WAAW,kBAAkB,IAAI,KAAK,GAAG;CAC/C,MAAM,eAAe,gBAAgB;AAGrC,KAAI,iBAAiB,EACnB,QAAO,GAAG;AAGZ,MAAK,MAAM,CAAC,KAAK,OAAO,uBACtB,KAAI,YAAY,cAAc,KAAK,KAAK,UAAU,EAAE;EAClD,MAAM,WAAW,YAAY,IAAI,KAAK;EACtC,MAAM,WAAW,YAAY;AAI7B,SAAO,GAAG,OAAO,WAHL,WACP,KAAK,cAAc,WAAW,KAAK,OACpC,KAC8B;;AAItC,QAAO,GAAG"}
+{"version":3,"file":"format-quantity.mjs","names":[],"sources":["../src/constants.ts","../src/formatQuantity.ts"],"sourcesContent":["import type {\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Default tolerance used by {@link formatQuantity} when determining if a number\n * is close enough to a fraction value to be considered equivalent.\n */\nexport const defaultTolerance = 0.0075 as const;\n\n/**\n * Default options for {@link formatQuantity}.\n */\nexport const defaultOptions: Readonly<ResolvedFormatQuantityOptions> = Object.freeze({\n  vulgarFractions: false,\n  tolerance: defaultTolerance,\n  fractionSlash: false,\n  romanNumerals: false,\n  zeroFormat: '',\n  allowTrailingInvalid: true,\n});\n\n/**\n * Map of vulgar fractions to their traditional ASCII equivalents.\n */\nexport const vulgarToAsciiMap: Readonly<Record<VulgarFraction, SimpleFraction>> = Object.freeze({\n  '¼': '1/4',\n  '½': '1/2',\n  '¾': '3/4',\n  '⅐': '1/7',\n  '⅑': '1/9',\n  '⅒': '1/10',\n  '⅓': '1/3',\n  '⅔': '2/3',\n  '⅕': '1/5',\n  '⅖': '2/5',\n  '⅗': '3/5',\n  '⅘': '4/5',\n  '⅙': '1/6',\n  '⅚': '5/6',\n  '⅛': '1/8',\n  '⅜': '3/8',\n  '⅝': '5/8',\n  '⅞': '7/8',\n});\n\n/**\n * Map of \"close enough\" values to the {@link VulgarFraction} or {@link Sixteenth} fraction\n * string matches. The value +/- the `tolerance` option (or {@link defaultTolerance} if not\n * specified) is considered close enough to match the fraction.\n */\nexport const fractionDecimalMatches: readonly (readonly [number, VulgarFraction | Sixteenth])[] =\n  Object.freeze(\n    (\n      [\n        [1 / 16, '1/16'],\n        [1 / 10, '⅒'],\n        [1 / 9, '⅑'],\n        [1 / 8, '⅛'],\n        [1 / 7, '⅐'],\n        [1 / 6, '⅙'],\n        [3 / 16, '3/16'],\n        [1 / 5, '⅕'],\n        [1 / 4, '¼'],\n        [5 / 16, '5/16'],\n        [1 / 3, '⅓'],\n        [3 / 8, '⅜'],\n        [2 / 5, '⅖'],\n        [7 / 16, '7/16'],\n        [1 / 2, '½'],\n        [9 / 16, '9/16'],\n        [3 / 5, '⅗'],\n        [5 / 8, '⅝'],\n        [2 / 3, '⅔'],\n        [11 / 16, '11/16'],\n        [3 / 4, '¾'],\n        [4 / 5, '⅘'],\n        [13 / 16, '13/16'],\n        [5 / 6, '⅚'],\n        [7 / 8, '⅞'],\n        [15 / 16, '15/16'],\n      ] satisfies [number, VulgarFraction | Sixteenth][]\n    ).map(entry => Object.freeze(entry))\n  );\n","import { numericQuantity } from 'numeric-quantity';\nimport { defaultOptions, fractionDecimalMatches, vulgarToAsciiMap } from './constants';\nimport type {\n  FormatQuantity,\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\nconst superscriptDigits = '⁰¹²³⁴⁵⁶⁷⁸⁹';\nconst subscriptDigits = '₀₁₂₃₄₅₆₇₈₉';\n\n// oxlint-disable-next-line typescript/no-misused-spread\nconst toSuperscript = (s: string) => [...s].map(c => superscriptDigits[+c]).join('');\n// oxlint-disable-next-line typescript/no-misused-spread\nconst toSubscript = (s: string) => [...s].map(c => subscriptDigits[+c]).join('');\n\n/**\n * Applies the `vulgarFractions` or `fractionSlash` options as necessary.\n */\nconst getFraction = (\n  vulgarFractionOrSixteenth: VulgarFraction | Sixteenth,\n  { fractionSlash, vulgarFractions }: ResolvedFormatQuantityOptions\n) => {\n  if (vulgarFractions) {\n    return vulgarFractionOrSixteenth;\n  }\n\n  const plainFraction: SimpleFraction =\n    vulgarToAsciiMap[vulgarFractionOrSixteenth as VulgarFraction] ?? vulgarFractionOrSixteenth;\n\n  if (fractionSlash) {\n    const [num, den] = plainFraction.split('/');\n    return `${toSuperscript(num)}⁄${toSubscript(den)}`;\n  }\n\n  return plainFraction;\n};\n\n/**\n * Only `false` (matching disabled) or a non-negative number is a valid\n * `tolerance`. Everything else—negative numbers, `NaN`, non-numbers,\n * `null`, `undefined`—resolves to {@link defaultTolerance}.\n */\nconst isValidTolerance = (tolerance: unknown): tolerance is number | false =>\n  tolerance === false || (typeof tolerance === 'number' && tolerance >= 0);\n\n/**\n * Merges options object with default options, converting boolean to object if necessary.\n */\nconst normalizeOptions = (\n  options: Parameters<FormatQuantity>[1]\n): ResolvedFormatQuantityOptions => {\n  const opts: ResolvedFormatQuantityOptions = {\n    ...defaultOptions,\n    ...(typeof options === 'boolean'\n      ? { vulgarFractions: options }\n      : typeof options === 'object' && options !== null\n        ? options\n        : {}),\n  };\n\n  if (!isValidTolerance(opts.tolerance)) {\n    opts.tolerance = defaultOptions.tolerance;\n  }\n\n  if (typeof opts.zeroFormat !== 'string') {\n    opts.zeroFormat = defaultOptions.zeroFormat;\n  }\n\n  if (opts.allowTrailingInvalid !== false) {\n    opts.allowTrailingInvalid = true;\n  }\n\n  return opts;\n};\n\n// oxfmt-ignore\nconst romanNumeralsByPlace = [\n  '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM',\n  '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC',\n  '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX',\n] as const;\n\n/**\n * Formats a number or bigint as Roman numerals. The number must be between\n * 1 and 3999, inclusive; any other value—including non-numbers,\n * `NaN`, and non-finite numbers—yields `null`.\n */\nexport const formatRomanNumerals = (quantity: number | bigint): string | null => {\n  if (\n    (typeof quantity !== 'number' && typeof quantity !== 'bigint') ||\n    !(quantity >= 1 && quantity < 4000)\n  ) {\n    return null;\n  }\n\n  const qty = Number(quantity);\n\n  const floored = Math.floor(qty);\n\n  const digits = `${floored}`.split('');\n  let roman = '';\n  let i = 3;\n  while (i--) {\n    roman = `${romanNumeralsByPlace[+digits.pop()! + i * 10] || ''}${roman}`;\n  }\n\n  return `${Array(+digits.join('') + 1).join('M')}${roman}`;\n};\n\n/**\n * Formats a number (or string that appears to be a number)\n * as one would see it written in imperial measurements, e.g.\n * \"1 1/2\" instead of \"1.5\". To use vulgar fraction characters\n * like \"½\", pass `true` as the second argument. For other options\n * see {@link FormatQuantityOptions}.\n */\nexport const formatQuantity: FormatQuantity = (qty, options) => {\n  // Only numbers, bigints, and strings are accepted. Anything else (objects, booleans,\n  // nullish, arrays like `[1]` that would coerce to a numeric string) is\n  // rejected up front so off-type inputs behave consistently.\n  if (typeof qty !== 'number' && typeof qty !== 'string' && typeof qty !== 'bigint') {\n    return null;\n  }\n\n  const opts = normalizeOptions(options);\n\n  const qtyAsNumber =\n    typeof qty !== 'number' && typeof qty !== 'bigint'\n      ? numericQuantity(qty, {\n          allowTrailingInvalid: opts.allowTrailingInvalid,\n          romanNumerals: opts.romanNumerals,\n          bigIntOnOverflow: true,\n          round: false,\n        })\n      : qty;\n\n  // Return `null` if input is not number-like.\n  if (typeof qtyAsNumber === 'number' && isNaN(qtyAsNumber)) {\n    return null;\n  }\n\n  // Return empty string (or configured `zeroFormat`) if the value is zero.\n  if (Number(qtyAsNumber) === 0) {\n    return opts.zeroFormat;\n  }\n\n  if (opts.romanNumerals) {\n    return formatRomanNumerals(qtyAsNumber);\n  }\n\n  const absoluteValue =\n    typeof qtyAsNumber === 'bigint'\n      ? qtyAsNumber < 0n\n        ? -qtyAsNumber\n        : qtyAsNumber\n      : Math.abs(qtyAsNumber);\n  const flooredAbsVal =\n    typeof absoluteValue === 'bigint' ? absoluteValue : Math.floor(absoluteValue);\n  const wholeNumberStr = `${flooredAbsVal || ''}`;\n  const decimalValue =\n    typeof absoluteValue === 'bigint' ? 0 : absoluteValue - (flooredAbsVal as number);\n\n  // For integers just return the given value as a string.\n  if (decimalValue === 0) {\n    return `${qtyAsNumber}`;\n  }\n\n  let closestMatch: VulgarFraction | Sixteenth | null = null;\n  let closestMatchDiff = Infinity;\n  // `tolerance: false` disables fraction matching entirely.\n  if (opts.tolerance !== false) {\n    for (const [num, vf] of fractionDecimalMatches) {\n      const diff = Math.abs(decimalValue - num);\n      // `diff === 0` keeps exact quotients matching even at `tolerance: 0`.\n      if (diff < opts.tolerance || diff === 0) {\n        if (diff === 0) {\n          closestMatch = vf;\n          break;\n        }\n        if (diff < closestMatchDiff) {\n          closestMatch = vf;\n          closestMatchDiff = diff;\n        }\n      }\n    }\n  }\n\n  if (closestMatch) {\n    const fraction = getFraction(closestMatch, opts);\n    const isVulgar = fraction in vulgarToAsciiMap;\n    const sep = wholeNumberStr ? (opts.separator ?? (isVulgar ? '' : ' ')) : '';\n    return `${qtyAsNumber < 0 ? '-' : ''}${wholeNumberStr}${sep}${fraction}`;\n  }\n\n  return `${qtyAsNumber}`;\n};\n"],"mappings":";;;;;;AAWA,MAAa,mBAAmB;;;;AAKhC,MAAa,iBAA0D,OAAO,OAAO;CACnF,iBAAiB;CACjB,WAAW;CACX,eAAe;CACf,eAAe;CACf,YAAY;CACZ,sBAAsB;AACxB,CAAC;;;;AAKD,MAAa,mBAAqE,OAAO,OAAO;CAC9F,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACP,CAAC;;;;;;AAOD,MAAa,yBACX,OAAO,OAEH;CACE,CAAC,IAAI,IAAI,MAAM;CACf,CAAC,IAAI,IAAI,GAAG;CACZ,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,IAAI,MAAM;CACf,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,IAAI,MAAM;CACf,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,IAAI,MAAM;CACf,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,IAAI,MAAM;CACf,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,KAAK,IAAI,OAAO;CACjB,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,KAAK,IAAI,OAAO;CACjB,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,IAAI,GAAG,GAAG;CACX,CAAC,KAAK,IAAI,OAAO;AACnB,CAAC,CACD,KAAI,UAAS,OAAO,OAAO,KAAK,CAAC,CACrC;;;AC5EF,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB;AAGxB,MAAM,iBAAiB,MAAc,CAAC,GAAG,CAAC,CAAC,CAAC,KAAI,MAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE;AAEnF,MAAM,eAAe,MAAc,CAAC,GAAG,CAAC,CAAC,CAAC,KAAI,MAAK,gBAAgB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE;;;;AAK/E,MAAM,eACJ,2BACA,EAAE,eAAe,sBACd;CACH,IAAI,iBACF,OAAO;CAGT,MAAM,gBACJ,iBAAiB,8BAAgD;CAEnE,IAAI,eAAe;EACjB,MAAM,CAAC,KAAK,OAAO,cAAc,MAAM,GAAG;EAC1C,OAAO,GAAG,cAAc,GAAG,EAAE,GAAG,YAAY,GAAG;CACjD;CAEA,OAAO;AACT;;;;;;AAOA,MAAM,oBAAoB,cACxB,cAAc,SAAU,OAAO,cAAc,YAAY,aAAa;;;;AAKxE,MAAM,oBACJ,YACkC;CAClC,MAAM,OAAsC;EAC1C,GAAG;EACH,GAAI,OAAO,YAAY,YACnB,EAAE,iBAAiB,QAAQ,IAC3B,OAAO,YAAY,YAAY,YAAY,OACzC,UACA,CAAC;CACT;CAEA,IAAI,CAAC,iBAAiB,KAAK,SAAS,GAClC,KAAK,YAAY,eAAe;CAGlC,IAAI,OAAO,KAAK,eAAe,UAC7B,KAAK,aAAa,eAAe;CAGnC,IAAI,KAAK,yBAAyB,OAChC,KAAK,uBAAuB;CAG9B,OAAO;AACT;AAGA,MAAM,uBAAuB;CAC3B;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;CACtD;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;CACtD;CAAI;CAAK;CAAM;CAAO;CAAM;CAAK;CAAM;CAAO;CAAQ;AACxD;;;;;;AAOA,MAAa,uBAAuB,aAA6C;CAC/E,IACG,OAAO,aAAa,YAAY,OAAO,aAAa,YACrD,EAAE,YAAY,KAAK,WAAW,MAE9B,OAAO;CAGT,MAAM,MAAM,OAAO,QAAQ;CAI3B,MAAM,SAAS,GAFC,KAAK,MAAM,GAEH,IAAI,MAAM,EAAE;CACpC,IAAI,QAAQ;CACZ,IAAI,IAAI;CACR,OAAO,KACL,QAAQ,GAAG,qBAAqB,CAAC,OAAO,IAAI,IAAK,IAAI,OAAO,KAAK;CAGnE,OAAO,GAAG,MAAM,CAAC,OAAO,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI;AACpD;;;;;;;;AASA,MAAa,kBAAkC,KAAK,YAAY;CAI9D,IAAI,OAAO,QAAQ,YAAY,OAAO,QAAQ,YAAY,OAAO,QAAQ,UACvE,OAAO;CAGT,MAAM,OAAO,iBAAiB,OAAO;CAErC,MAAM,cACJ,OAAO,QAAQ,YAAY,OAAO,QAAQ,WACtC,gBAAgB,KAAK;EACnB,sBAAsB,KAAK;EAC3B,eAAe,KAAK;EACpB,kBAAkB;EAClB,OAAO;CACT,CAAC,IACD;CAGN,IAAI,OAAO,gBAAgB,YAAY,MAAM,WAAW,GACtD,OAAO;CAIT,IAAI,OAAO,WAAW,MAAM,GAC1B,OAAO,KAAK;CAGd,IAAI,KAAK,eACP,OAAO,oBAAoB,WAAW;CAGxC,MAAM,gBACJ,OAAO,gBAAgB,WACnB,cAAc,KACZ,CAAC,cACD,cACF,KAAK,IAAI,WAAW;CAC1B,MAAM,gBACJ,OAAO,kBAAkB,WAAW,gBAAgB,KAAK,MAAM,aAAa;CAC9E,MAAM,iBAAiB,GAAG,iBAAiB;CAC3C,MAAM,eACJ,OAAO,kBAAkB,WAAW,IAAI,gBAAiB;CAG3D,IAAI,iBAAiB,GACnB,OAAO,GAAG;CAGZ,IAAI,eAAkD;CACtD,IAAI,mBAAmB;CAEvB,IAAI,KAAK,cAAc,OACrB,KAAK,MAAM,CAAC,KAAK,OAAO,wBAAwB;EAC9C,MAAM,OAAO,KAAK,IAAI,eAAe,GAAG;EAExC,IAAI,OAAO,KAAK,aAAa,SAAS,GAAG;GACvC,IAAI,SAAS,GAAG;IACd,eAAe;IACf;GACF;GACA,IAAI,OAAO,kBAAkB;IAC3B,eAAe;IACf,mBAAmB;GACrB;EACF;CACF;CAGF,IAAI,cAAc;EAChB,MAAM,WAAW,YAAY,cAAc,IAAI;EAC/C,MAAM,WAAW,YAAY;EAC7B,MAAM,MAAM,iBAAkB,KAAK,cAAc,WAAW,KAAK,OAAQ;EACzE,OAAO,GAAG,cAAc,IAAI,MAAM,KAAK,iBAAiB,MAAM;CAChE;CAEA,OAAO,GAAG;AACZ"}

package/dist/format-quantity.production.d.mts

@@ -1,107 +1,131 @@
 //#region src/types.d.ts
 interface FormatQuantityOptions {
   /**
-  * Output vulgar fractions, like "½" instead of "1/2", when appropriate.
-  * Overrides the `fractionSlash` option.
-  */
+   * Output vulgar fractions, like "½" instead of "1/2", when appropriate.
+   * Overrides the `fractionSlash` option.
+   *
+   * @default false
+   */
   vulgarFractions?: boolean;
   /**
-  * Amount by which a number can deviate from the calculated quotient to be
-  * considered a match. For example, 0.66 is close enough to 2 ÷ 3 (which
-  * is 0.66666... repeating) to be considered equivalent so the function
-  * will return "2/3". The smaller this number, the higher the likelihood that
-  * the function will return a decimal instead of a fraction or mixed number.
-  *
-  * @default 0.0075
-  */
-  tolerance?: number;
+   * Amount by which a number can deviate from the calculated quotient to be
+   * considered a match. For example, 0.66 is close enough to 2 ÷ 3 (which
+   * is 0.66666... repeating) to be considered equivalent so the function
+   * will return "2/3". The smaller this number, the higher the likelihood that
+   * the function will return a decimal instead of a fraction or mixed number.
+   *
+   * `0` means only exact quotients match. `false` disables fraction matching
+   * entirely, so decimal values are always returned as decimals.
+   *
+   * Any other value—negative, non-numeric, `NaN`, `null`, `undefined`—resolves
+   * to the default.
+   *
+   * @default 0.0075
+   */
+  tolerance?: number | false;
   /**
-  * Output the fraction slash character (⁄) instead of the "solidus"
-  * slash (/) for fractions. Results appear like "1⁄2" instead of "1/2".
-  * Overridden by the `vulgarFractions` option.
-  */
+   * Output the fraction slash character (⁄) instead of the "solidus"
+   * slash (/) for fractions. Results appear like "1⁄2" instead of "1/2".
+   * Overridden by the `vulgarFractions` option.
+   *
+   * @default false
+   */
   fractionSlash?: boolean;
   /**
-  * Output in Roman numerals. Provided value must be between 1 and 3999, inclusive.
-  * Decimal values will be ignored (`Math.floor` is used to remove them). Overrides
-  * all other options.
-  */
+   * Output in Roman numerals. Provided value must be between 1 and 3999, inclusive.
+   * Decimal values will be ignored (`Math.floor` is used to remove them). Overrides
+   * all other options.
+   *
+   * @default false
+   */
   romanNumerals?: boolean;
   /**
-  * String to place between the whole number and fraction parts. When not specified,
-  * defaults to `" "` for ASCII and fraction-slash fractions, and `""` for vulgar
-  * fractions (preserving the standard typographic convention of no space before
-  * vulgar fraction characters).
-  */
+   * String to place between the whole number and fraction parts. When not specified,
+   * defaults to `" "` for ASCII and fraction-slash fractions, and `""` for vulgar
+   * fractions (preserving the standard typographic convention of no space before
+   * vulgar fraction characters).
+   */
   separator?: string;
+  /**
+   * String to return when the input evaluates numerically to zero.
+   *
+   * @default "" (empty string)
+   */
+  zeroFormat?: string;
+  /**
+   * If `qty` is a string, allow trailing invalid characters after the numeric portion.
+   *
+   * @default true
+   */
+  allowTrailingInvalid?: boolean;
 }
 /**
-* {@link FormatQuantityOptions} with all properties resolved to their
-* default values, except {@link FormatQuantityOptions.separator | separator}
-* which remains optional so that unset vs explicitly-set can be distinguished.
-*/
+ * {@link FormatQuantityOptions} with all properties resolved to their
+ * default values, except {@link FormatQuantityOptions.separator | separator}
+ * which remains optional so that unset vs explicitly-set can be distinguished.
+ */
 type ResolvedFormatQuantityOptions = Required<Omit<FormatQuantityOptions, "separator">> & Pick<FormatQuantityOptions, "separator">;
 /**
-* Function signature of {@link formatQuantity}.
-*/
+ * Function signature of {@link formatQuantity}.
+ */
 interface FormatQuantity {
-  (qty: string | number, options?: boolean | FormatQuantityOptions): string | null;
+  (qty: string | number | bigint, options?: boolean | FormatQuantityOptions): string | null;
 }
 /** Any numeric character. */
 type Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
 /** Any numeric character except '0'. */
 type NonZeroDigit = Exclude<Digit, "0">;
 /**
-* Fraction string with either one or two numeric characters in both the
-* numerator and denominator (but not two characters in the numerator while
-* the denominator only has one).
-*/
+ * Fraction string with either one or two numeric characters in both the
+ * numerator and denominator (but not two characters in the numerator while
+ * the denominator only has one).
+ */
 type SimpleFraction = `${NonZeroDigit}/${NonZeroDigit}` | `${NonZeroDigit}/${NonZeroDigit}${Digit}` | `${NonZeroDigit}${Digit}/${NonZeroDigit}${Digit}`;
 /**
-* Odd numerator sixteenth fraction strings.
-*/
+ * Odd numerator sixteenth fraction strings.
+ */
 type Sixteenth = `${"1" | "3" | "5" | "7" | "9" | "11" | "13" | "15"}/16`;
 /**
-* Unicode vulgar fraction code points.
-*/
+ * Unicode vulgar fraction code points.
+ */
 type VulgarFraction = "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞";
-/** @hidden */
-type FormatQuantityTests = Record<string, ([Parameters<FormatQuantity>[0], ReturnType<FormatQuantity>] | [Parameters<FormatQuantity>[0], ReturnType<FormatQuantity>, Parameters<FormatQuantity>[1]])[]>;
 //#endregion
 //#region src/constants.d.ts
 /**
-* Default tolerance used by {@link formatQuantity} when determining if a number
-* is close enough to a fraction value to be considered equivalent.
-*/
+ * Default tolerance used by {@link formatQuantity} when determining if a number
+ * is close enough to a fraction value to be considered equivalent.
+ */
 declare const defaultTolerance: 0.0075;
 /**
-* Default options for {@link formatQuantity}.
-*/
-declare const defaultOptions: ResolvedFormatQuantityOptions;
+ * Default options for {@link formatQuantity}.
+ */
+declare const defaultOptions: Readonly<ResolvedFormatQuantityOptions>;
 /**
-* Map of vulgar fractions to their traditional ASCII equivalents.
-*/
-declare const vulgarToAsciiMap: Record<VulgarFraction, SimpleFraction>;
+ * Map of vulgar fractions to their traditional ASCII equivalents.
+ */
+declare const vulgarToAsciiMap: Readonly<Record<VulgarFraction, SimpleFraction>>;
 /**
-* Map of "close enough" decimal values to the {@link VulgarFraction} or
-* {@link Sixteenth} fraction string matches.
-*/
-declare const fractionDecimalMatches: [number, VulgarFraction | Sixteenth][];
+ * Map of "close enough" values to the {@link VulgarFraction} or {@link Sixteenth} fraction
+ * string matches. The value +/- the `tolerance` option (or {@link defaultTolerance} if not
+ * specified) is considered close enough to match the fraction.
+ */
+declare const fractionDecimalMatches: readonly (readonly [number, VulgarFraction | Sixteenth])[];
 //#endregion
 //#region src/formatQuantity.d.ts
 /**
-* Formats a number as Roman numerals. The number must be between
-* 1 and 3999, inclusive.
-*/
-declare const formatRomanNumerals: (qty: number) => string | null;
+ * Formats a number or bigint as Roman numerals. The number must be between
+ * 1 and 3999, inclusive; any other value—including non-numbers,
+ * `NaN`, and non-finite numbers—yields `null`.
+ */
+declare const formatRomanNumerals: (quantity: number | bigint) => string | null;
 /**
-* Formats a number (or string that appears to be a number)
-* as one would see it written in imperial measurements, e.g.
-* "1 1/2" instead of "1.5". To use vulgar fraction characters
-* like "½", pass `true` as the second argument. For other options
-* see {@link FormatQuantityOptions}.
-*/
+ * Formats a number (or string that appears to be a number)
+ * as one would see it written in imperial measurements, e.g.
+ * "1 1/2" instead of "1.5". To use vulgar fraction characters
+ * like "½", pass `true` as the second argument. For other options
+ * see {@link FormatQuantityOptions}.
+ */
 declare const formatQuantity: FormatQuantity;
 //#endregion
-export { Digit, FormatQuantity, FormatQuantityOptions, FormatQuantityTests, NonZeroDigit, ResolvedFormatQuantityOptions, SimpleFraction, Sixteenth, VulgarFraction, defaultOptions, defaultTolerance, formatQuantity, formatRomanNumerals, fractionDecimalMatches, vulgarToAsciiMap };
+export { Digit, FormatQuantity, FormatQuantityOptions, NonZeroDigit, ResolvedFormatQuantityOptions, SimpleFraction, Sixteenth, VulgarFraction, defaultOptions, defaultTolerance, formatQuantity, formatRomanNumerals, fractionDecimalMatches, vulgarToAsciiMap };
 //# sourceMappingURL=format-quantity.production.d.mts.map

package/dist/format-quantity.production.mjs

@@ -1,2 +1,2 @@
-import{numericQuantity as e}from"numeric-quantity";const t=.0075,n={vulgarFractions:!1,tolerance:t,fractionSlash:!1,romanNumerals:!1},r={"¼":`1/4`,"½":`1/2`,"¾":`3/4`,"⅐":`1/7`,"⅑":`1/9`,"⅒":`1/10`,"⅓":`1/3`,"⅔":`2/3`,"⅕":`1/5`,"⅖":`2/5`,"⅗":`3/5`,"⅘":`4/5`,"⅙":`1/6`,"⅚":`5/6`,"⅛":`1/8`,"⅜":`3/8`,"⅝":`5/8`,"⅞":`7/8`},i=[[.33,`⅓`],[.66,`⅔`],[.2,`⅕`],[.4,`⅖`],[.6,`⅗`],[.8,`⅘`],[.166,`⅙`],[.833,`⅚`],[.143,`⅐`],[.111,`⅑`],[.1,`⅒`],[.125,`⅛`],[.25,`¼`],[.375,`⅜`],[.5,`½`],[.625,`⅝`],[.75,`¾`],[.875,`⅞`],[.0625,`1/16`],[.1875,`3/16`],[.3125,`5/16`],[.4375,`7/16`],[.5625,`9/16`],[.6875,`11/16`],[.8125,`13/16`],[.9375,`15/16`]],a=(e,t,n)=>Math.abs(e-t)<n,o=e=>{let t=``;for(let n=0;n<e.length;n++)t+=`⁰¹²³⁴⁵⁶⁷⁸⁹`[+e[n]];return t},s=e=>{let t=``;for(let n=0;n<e.length;n++)t+=`₀₁₂₃₄₅₆₇₈₉`[+e[n]];return t},c=(e,{fractionSlash:t,vulgarFractions:n})=>{if(n)return e;let i=r[e]??e;if(t){let[e,t]=i.split(`/`);return`${o(e)}⁄${s(t)}`}return i},l=e=>({...n,...typeof e==`boolean`?{vulgarFractions:e}:e}),u=`.C.CC.CCC.CD.D.DC.DCC.DCCC.CM..X.XX.XXX.XL.L.LX.LXX.LXXX.XC..I.II.III.IV.V.VI.VII.VIII.IX`.split(`.`),d=e=>{if(typeof e!=`number`||isNaN(e))return null;if(e<1||e>=4e3)return``;let t=`${Math.floor(e)}`.split(``),n=``,r=3;for(;r--;)n=`${u[+t.pop()+r*10]||``}${n}`;return`${Array(+t.join(``)+1).join(`M`)}${n}`},f=(t,o=n)=>{let s=typeof t==`string`?e(t,{round:!1,allowTrailingInvalid:!0}):t;if(isNaN(s)||s===null)return null;if(s===0)return``;let u=l(o??n);if(u.romanNumerals)return d(s);let f=Math.abs(s),p=Math.floor(f),m=s<0?`-`:``,h=p===0?``:`${p}`,g=f-p;if(g===0)return`${s}`;for(let[e,t]of i)if(a(g,e,u.tolerance)){let e=c(t,u),n=e in r;return`${m}${h}${h?u.separator??(n?``:` `):``}${e}`}return`${s}`};export{n as defaultOptions,t as defaultTolerance,f as formatQuantity,d as formatRomanNumerals,i as fractionDecimalMatches,r as vulgarToAsciiMap};
+import{numericQuantity as e}from"numeric-quantity";const t=.0075,n=Object.freeze({vulgarFractions:!1,tolerance:t,fractionSlash:!1,romanNumerals:!1,zeroFormat:``,allowTrailingInvalid:!0}),r=Object.freeze({"¼":`1/4`,"½":`1/2`,"¾":`3/4`,"⅐":`1/7`,"⅑":`1/9`,"⅒":`1/10`,"⅓":`1/3`,"⅔":`2/3`,"⅕":`1/5`,"⅖":`2/5`,"⅗":`3/5`,"⅘":`4/5`,"⅙":`1/6`,"⅚":`5/6`,"⅛":`1/8`,"⅜":`3/8`,"⅝":`5/8`,"⅞":`7/8`}),i=Object.freeze([[1/16,`1/16`],[1/10,`⅒`],[1/9,`⅑`],[1/8,`⅛`],[1/7,`⅐`],[1/6,`⅙`],[3/16,`3/16`],[1/5,`⅕`],[1/4,`¼`],[5/16,`5/16`],[1/3,`⅓`],[3/8,`⅜`],[2/5,`⅖`],[7/16,`7/16`],[1/2,`½`],[9/16,`9/16`],[3/5,`⅗`],[5/8,`⅝`],[2/3,`⅔`],[11/16,`11/16`],[3/4,`¾`],[4/5,`⅘`],[13/16,`13/16`],[5/6,`⅚`],[7/8,`⅞`],[15/16,`15/16`]].map(e=>Object.freeze(e))),a=e=>[...e].map(e=>`⁰¹²³⁴⁵⁶⁷⁸⁹`[+e]).join(``),o=e=>[...e].map(e=>`₀₁₂₃₄₅₆₇₈₉`[+e]).join(``),s=(e,{fractionSlash:t,vulgarFractions:n})=>{if(n)return e;let i=r[e]??e;if(t){let[e,t]=i.split(`/`);return`${a(e)}⁄${o(t)}`}return i},c=e=>e===!1||typeof e==`number`&&e>=0,l=e=>{let t={...n,...typeof e==`boolean`?{vulgarFractions:e}:typeof e==`object`&&e?e:{}};return c(t.tolerance)||(t.tolerance=n.tolerance),typeof t.zeroFormat!=`string`&&(t.zeroFormat=n.zeroFormat),t.allowTrailingInvalid!==!1&&(t.allowTrailingInvalid=!0),t},u=`.C.CC.CCC.CD.D.DC.DCC.DCCC.CM..X.XX.XXX.XL.L.LX.LXX.LXXX.XC..I.II.III.IV.V.VI.VII.VIII.IX`.split(`.`),d=e=>{if(typeof e!=`number`&&typeof e!=`bigint`||!(e>=1&&e<4e3))return null;let t=Number(e),n=`${Math.floor(t)}`.split(``),r=``,i=3;for(;i--;)r=`${u[+n.pop()+i*10]||``}${r}`;return`${Array(+n.join(``)+1).join(`M`)}${r}`},f=(t,n)=>{if(typeof t!=`number`&&typeof t!=`string`&&typeof t!=`bigint`)return null;let a=l(n),o=typeof t!=`number`&&typeof t!=`bigint`?e(t,{allowTrailingInvalid:a.allowTrailingInvalid,romanNumerals:a.romanNumerals,bigIntOnOverflow:!0,round:!1}):t;if(typeof o==`number`&&isNaN(o))return null;if(Number(o)===0)return a.zeroFormat;if(a.romanNumerals)return d(o);let c=typeof o==`bigint`?o<0n?-o:o:Math.abs(o),u=typeof c==`bigint`?c:Math.floor(c),f=`${u||``}`,p=typeof c==`bigint`?0:c-u;if(p===0)return`${o}`;let m=null,h=1/0;if(a.tolerance!==!1)for(let[e,t]of i){let n=Math.abs(p-e);if(n<a.tolerance||n===0){if(n===0){m=t;break}n<h&&(m=t,h=n)}}if(m){let e=s(m,a),t=e in r,n=f?a.separator??(t?``:` `):``;return`${o<0?`-`:``}${f}${n}${e}`}return`${o}`};export{n as defaultOptions,t as defaultTolerance,f as formatQuantity,d as formatRomanNumerals,i as fractionDecimalMatches,r as vulgarToAsciiMap};
 //# sourceMappingURL=format-quantity.production.mjs.map

package/dist/format-quantity.production.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"format-quantity.production.mjs","names":[],"sources":["../src/constants.ts","../src/formatQuantity.ts"],"sourcesContent":["import type {\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Default tolerance used by {@link formatQuantity} when determining if a number\n * is close enough to a fraction value to be considered equivalent.\n */\nexport const defaultTolerance = 0.0075 as const;\n\n/**\n * Default options for {@link formatQuantity}.\n */\nexport const defaultOptions: ResolvedFormatQuantityOptions = {\n  vulgarFractions: false,\n  tolerance: defaultTolerance,\n  fractionSlash: false,\n  romanNumerals: false,\n} as const;\n\n/**\n * Map of vulgar fractions to their traditional ASCII equivalents.\n */\nexport const vulgarToAsciiMap: Record<VulgarFraction, SimpleFraction> = {\n  '¼': '1/4',\n  '½': '1/2',\n  '¾': '3/4',\n  '⅐': '1/7',\n  '⅑': '1/9',\n  '⅒': '1/10',\n  '⅓': '1/3',\n  '⅔': '2/3',\n  '⅕': '1/5',\n  '⅖': '2/5',\n  '⅗': '3/5',\n  '⅘': '4/5',\n  '⅙': '1/6',\n  '⅚': '5/6',\n  '⅛': '1/8',\n  '⅜': '3/8',\n  '⅝': '5/8',\n  '⅞': '7/8',\n} as const;\n\n/**\n * Map of \"close enough\" decimal values to the {@link VulgarFraction} or\n * {@link Sixteenth} fraction string matches.\n */\nexport const fractionDecimalMatches: [number, VulgarFraction | Sixteenth][] = [\n  [0.33, '⅓'],\n  [0.66, '⅔'],\n  [0.2, '⅕'],\n  [0.4, '⅖'],\n  [0.6, '⅗'],\n  [0.8, '⅘'],\n  [0.166, '⅙'],\n  [0.833, '⅚'],\n  [0.143, '⅐'],\n  [0.111, '⅑'],\n  [0.1, '⅒'],\n  [0.125, '⅛'],\n  [0.25, '¼'],\n  [0.375, '⅜'],\n  [0.5, '½'],\n  [0.625, '⅝'],\n  [0.75, '¾'],\n  [0.875, '⅞'],\n  [0.0625, '1/16'],\n  [0.1875, '3/16'],\n  [0.3125, '5/16'],\n  [0.4375, '7/16'],\n  [0.5625, '9/16'],\n  [0.6875, '11/16'],\n  [0.8125, '13/16'],\n  [0.9375, '15/16'],\n] as const;\n","import { numericQuantity } from 'numeric-quantity';\nimport {\n  defaultOptions,\n  fractionDecimalMatches,\n  vulgarToAsciiMap,\n} from './constants';\nimport type {\n  FormatQuantity,\n  FormatQuantityOptions,\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Determines if two numbers are close enough to consider\n * them equal for the purposes of this package.\n */\nconst closeEnough = (n1: number, n2: number, tolerance: number) =>\n  Math.abs(n1 - n2) < tolerance;\n\nconst superscriptDigits = '⁰¹²³⁴⁵⁶⁷⁸⁹';\nconst subscriptDigits = '₀₁₂₃₄₅₆₇₈₉';\n\nconst toSuperscript = (s: string) => {\n  let r = '';\n  for (let i = 0; i < s.length; i++) r += superscriptDigits[+s[i]];\n  return r;\n};\nconst toSubscript = (s: string) => {\n  let r = '';\n  for (let i = 0; i < s.length; i++) r += subscriptDigits[+s[i]];\n  return r;\n};\n\n/**\n * Applies the `vulgarFractions` or `fractionSlash` options as necessary.\n */\nconst getFraction = (\n  vulgarFractionOrSixteenth: VulgarFraction | Sixteenth,\n  { fractionSlash, vulgarFractions }: FormatQuantityOptions\n) => {\n  if (vulgarFractions) {\n    return vulgarFractionOrSixteenth;\n  }\n\n  const plainFraction: SimpleFraction =\n    vulgarToAsciiMap[vulgarFractionOrSixteenth as VulgarFraction] ??\n    vulgarFractionOrSixteenth;\n\n  if (fractionSlash) {\n    const [num, den] = plainFraction.split('/');\n    return `${toSuperscript(num)}⁄${toSubscript(den)}`;\n  }\n\n  return plainFraction;\n};\n\n/**\n * Merges options object with default options, converting boolean to object if necessary.\n */\nconst normalizeOptions = (\n  options: Parameters<FormatQuantity>[1]\n): ResolvedFormatQuantityOptions => ({\n  ...defaultOptions,\n  ...(typeof options === 'boolean' ? { vulgarFractions: options } : options),\n});\n\n// prettier-ignore\nconst romanNumeralValueKey = [\n  \"\", \"C\", \"CC\", \"CCC\", \"CD\", \"D\", \"DC\", \"DCC\", \"DCCC\", \"CM\",\n  \"\", \"X\", \"XX\", \"XXX\", \"XL\", \"L\", \"LX\", \"LXX\", \"LXXX\", \"XC\",\n  \"\", \"I\", \"II\", \"III\", \"IV\", \"V\", \"VI\", \"VII\", \"VIII\", \"IX\",\n] as const;\n\n/**\n * Formats a number as Roman numerals. The number must be between\n * 1 and 3999, inclusive.\n */\nexport const formatRomanNumerals = (qty: number): string | null => {\n  if (typeof qty !== 'number' || isNaN(qty)) {\n    return null;\n  }\n\n  if (qty < 1 || qty >= 4000) {\n    return '';\n  }\n\n  const floored = Math.floor(qty);\n\n  const digits = `${floored}`.split('');\n  let roman = '';\n  let i = 3;\n  while (i--) {\n    roman = `${romanNumeralValueKey[+digits.pop()! + i * 10] || ''}${roman}`;\n  }\n\n  return `${Array(+digits.join('') + 1).join('M')}${roman}`;\n};\n\n/**\n * Formats a number (or string that appears to be a number)\n * as one would see it written in imperial measurements, e.g.\n * \"1 1/2\" instead of \"1.5\". To use vulgar fraction characters\n * like \"½\", pass `true` as the second argument. For other options\n * see {@link FormatQuantityOptions}.\n */\nexport const formatQuantity: FormatQuantity = (\n  qty,\n  options = defaultOptions\n) => {\n  const qtyAsNumber =\n    typeof qty === 'string'\n      ? numericQuantity(qty, { round: false, allowTrailingInvalid: true })\n      : qty;\n\n  // Return `null` if input is not number-like.\n  if (isNaN(qtyAsNumber) || qtyAsNumber === null) {\n    return null;\n  }\n\n  // Return an empty string if the value is zero.\n  // TODO: Consider a `zeroDisplay` option (e.g. `{ zeroDisplay: \"0\" }`) so\n  // callers outside the recipe-ingredient use case can get \"0\" instead of \"\".\n  if (qtyAsNumber === 0) {\n    return '';\n  }\n\n  // The default options parameter in the function signature only takes effect\n  // if the parameter is `undefined`. The nullish coalescing operator below\n  // covers the `null` case.\n  const opts = normalizeOptions(options ?? defaultOptions);\n\n  if (opts.romanNumerals) {\n    return formatRomanNumerals(qtyAsNumber);\n  }\n\n  const absoluteValue = Math.abs(qtyAsNumber);\n  const flooredAbsVal = Math.floor(absoluteValue);\n  const sign = qtyAsNumber < 0 ? '-' : '';\n  const wholeStr = flooredAbsVal === 0 ? '' : `${flooredAbsVal}`;\n  const decimalValue = absoluteValue - flooredAbsVal;\n\n  // For integers just return the given value as a string.\n  if (decimalValue === 0) {\n    return `${qtyAsNumber}`;\n  }\n\n  for (const [num, vf] of fractionDecimalMatches) {\n    if (closeEnough(decimalValue, num, opts.tolerance)) {\n      const fraction = getFraction(vf, opts);\n      const isVulgar = fraction in vulgarToAsciiMap;\n      const sep = wholeStr\n        ? (opts.separator ?? (isVulgar ? '' : ' '))\n        : '';\n      return `${sign}${wholeStr}${sep}${fraction}`;\n    }\n  }\n\n  return `${qtyAsNumber}`;\n};\n"],"mappings":"mDAWA,MAAa,EAAmB,MAKnB,EAAgD,CAC3D,gBAAiB,GACjB,UAAW,EACX,cAAe,GACf,cAAe,GAChB,CAKY,EAA2D,CACtE,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,OACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACN,CAMY,EAAiE,CAC5E,CAAC,IAAM,IAAI,CACX,CAAC,IAAM,IAAI,CACX,CAAC,GAAK,IAAI,CACV,CAAC,GAAK,IAAI,CACV,CAAC,GAAK,IAAI,CACV,CAAC,GAAK,IAAI,CACV,CAAC,KAAO,IAAI,CACZ,CAAC,KAAO,IAAI,CACZ,CAAC,KAAO,IAAI,CACZ,CAAC,KAAO,IAAI,CACZ,CAAC,GAAK,IAAI,CACV,CAAC,KAAO,IAAI,CACZ,CAAC,IAAM,IAAI,CACX,CAAC,KAAO,IAAI,CACZ,CAAC,GAAK,IAAI,CACV,CAAC,KAAO,IAAI,CACZ,CAAC,IAAM,IAAI,CACX,CAAC,KAAO,IAAI,CACZ,CAAC,MAAQ,OAAO,CAChB,CAAC,MAAQ,OAAO,CAChB,CAAC,MAAQ,OAAO,CAChB,CAAC,MAAQ,OAAO,CAChB,CAAC,MAAQ,OAAO,CAChB,CAAC,MAAQ,QAAQ,CACjB,CAAC,MAAQ,QAAQ,CACjB,CAAC,MAAQ,QAAQ,CAClB,CC3DK,GAAe,EAAY,EAAY,IAC3C,KAAK,IAAI,EAAK,EAAG,CAAG,EAKhB,EAAiB,GAAc,CACnC,IAAI,EAAI,GACR,IAAK,IAAI,EAAI,EAAG,EAAI,EAAE,OAAQ,IAAK,GAAK,aAAkB,CAAC,EAAE,IAC7D,OAAO,GAEH,EAAe,GAAc,CACjC,IAAI,EAAI,GACR,IAAK,IAAI,EAAI,EAAG,EAAI,EAAE,OAAQ,IAAK,GAAK,aAAgB,CAAC,EAAE,IAC3D,OAAO,GAMH,GACJ,EACA,CAAE,gBAAe,qBACd,CACH,GAAI,EACF,OAAO,EAGT,IAAM,EACJ,EAAiB,IACjB,EAEF,GAAI,EAAe,CACjB,GAAM,CAAC,EAAK,GAAO,EAAc,MAAM,IAAI,CAC3C,MAAO,GAAG,EAAc,EAAI,CAAC,GAAG,EAAY,EAAI,GAGlD,OAAO,GAMH,EACJ,IACmC,CACnC,GAAG,EACH,GAAI,OAAO,GAAY,UAAY,CAAE,gBAAiB,EAAS,CAAG,EACnE,EAGK,EAAuB,sGAI5B,CAMY,EAAuB,GAA+B,CACjE,GAAI,OAAO,GAAQ,UAAY,MAAM,EAAI,CACvC,OAAO,KAGT,GAAI,EAAM,GAAK,GAAO,IACpB,MAAO,GAKT,IAAM,EAAS,GAFC,KAAK,MAAM,EAAI,GAEH,MAAM,GAAG,CACjC,EAAQ,GACR,EAAI,EACR,KAAO,KACL,EAAQ,GAAG,EAAqB,CAAC,EAAO,KAAK,CAAI,EAAI,KAAO,KAAK,IAGnE,MAAO,GAAG,MAAM,CAAC,EAAO,KAAK,GAAG,CAAG,EAAE,CAAC,KAAK,IAAI,GAAG,KAUvC,GACX,EACA,EAAU,IACP,CACH,IAAM,EACJ,OAAO,GAAQ,SACX,EAAgB,EAAK,CAAE,MAAO,GAAO,qBAAsB,GAAM,CAAC,CAClE,EAGN,GAAI,MAAM,EAAY,EAAI,IAAgB,KACxC,OAAO,KAMT,GAAI,IAAgB,EAClB,MAAO,GAMT,IAAM,EAAO,EAAiB,GAAW,EAAe,CAExD,GAAI,EAAK,cACP,OAAO,EAAoB,EAAY,CAGzC,IAAM,EAAgB,KAAK,IAAI,EAAY,CACrC,EAAgB,KAAK,MAAM,EAAc,CACzC,EAAO,EAAc,EAAI,IAAM,GAC/B,EAAW,IAAkB,EAAI,GAAK,GAAG,IACzC,EAAe,EAAgB,EAGrC,GAAI,IAAiB,EACnB,MAAO,GAAG,IAGZ,IAAK,GAAM,CAAC,EAAK,KAAO,EACtB,GAAI,EAAY,EAAc,EAAK,EAAK,UAAU,CAAE,CAClD,IAAM,EAAW,EAAY,EAAI,EAAK,CAChC,EAAW,KAAY,EAI7B,MAAO,GAAG,IAAO,IAHL,EACP,EAAK,YAAc,EAAW,GAAK,KACpC,KAC8B,IAItC,MAAO,GAAG"}
+{"version":3,"file":"format-quantity.production.mjs","names":[],"sources":["../src/constants.ts","../src/formatQuantity.ts"],"sourcesContent":["import type {\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\n/**\n * Default tolerance used by {@link formatQuantity} when determining if a number\n * is close enough to a fraction value to be considered equivalent.\n */\nexport const defaultTolerance = 0.0075 as const;\n\n/**\n * Default options for {@link formatQuantity}.\n */\nexport const defaultOptions: Readonly<ResolvedFormatQuantityOptions> = Object.freeze({\n  vulgarFractions: false,\n  tolerance: defaultTolerance,\n  fractionSlash: false,\n  romanNumerals: false,\n  zeroFormat: '',\n  allowTrailingInvalid: true,\n});\n\n/**\n * Map of vulgar fractions to their traditional ASCII equivalents.\n */\nexport const vulgarToAsciiMap: Readonly<Record<VulgarFraction, SimpleFraction>> = Object.freeze({\n  '¼': '1/4',\n  '½': '1/2',\n  '¾': '3/4',\n  '⅐': '1/7',\n  '⅑': '1/9',\n  '⅒': '1/10',\n  '⅓': '1/3',\n  '⅔': '2/3',\n  '⅕': '1/5',\n  '⅖': '2/5',\n  '⅗': '3/5',\n  '⅘': '4/5',\n  '⅙': '1/6',\n  '⅚': '5/6',\n  '⅛': '1/8',\n  '⅜': '3/8',\n  '⅝': '5/8',\n  '⅞': '7/8',\n});\n\n/**\n * Map of \"close enough\" values to the {@link VulgarFraction} or {@link Sixteenth} fraction\n * string matches. The value +/- the `tolerance` option (or {@link defaultTolerance} if not\n * specified) is considered close enough to match the fraction.\n */\nexport const fractionDecimalMatches: readonly (readonly [number, VulgarFraction | Sixteenth])[] =\n  Object.freeze(\n    (\n      [\n        [1 / 16, '1/16'],\n        [1 / 10, '⅒'],\n        [1 / 9, '⅑'],\n        [1 / 8, '⅛'],\n        [1 / 7, '⅐'],\n        [1 / 6, '⅙'],\n        [3 / 16, '3/16'],\n        [1 / 5, '⅕'],\n        [1 / 4, '¼'],\n        [5 / 16, '5/16'],\n        [1 / 3, '⅓'],\n        [3 / 8, '⅜'],\n        [2 / 5, '⅖'],\n        [7 / 16, '7/16'],\n        [1 / 2, '½'],\n        [9 / 16, '9/16'],\n        [3 / 5, '⅗'],\n        [5 / 8, '⅝'],\n        [2 / 3, '⅔'],\n        [11 / 16, '11/16'],\n        [3 / 4, '¾'],\n        [4 / 5, '⅘'],\n        [13 / 16, '13/16'],\n        [5 / 6, '⅚'],\n        [7 / 8, '⅞'],\n        [15 / 16, '15/16'],\n      ] satisfies [number, VulgarFraction | Sixteenth][]\n    ).map(entry => Object.freeze(entry))\n  );\n","import { numericQuantity } from 'numeric-quantity';\nimport { defaultOptions, fractionDecimalMatches, vulgarToAsciiMap } from './constants';\nimport type {\n  FormatQuantity,\n  ResolvedFormatQuantityOptions,\n  SimpleFraction,\n  Sixteenth,\n  VulgarFraction,\n} from './types';\n\nconst superscriptDigits = '⁰¹²³⁴⁵⁶⁷⁸⁹';\nconst subscriptDigits = '₀₁₂₃₄₅₆₇₈₉';\n\n// oxlint-disable-next-line typescript/no-misused-spread\nconst toSuperscript = (s: string) => [...s].map(c => superscriptDigits[+c]).join('');\n// oxlint-disable-next-line typescript/no-misused-spread\nconst toSubscript = (s: string) => [...s].map(c => subscriptDigits[+c]).join('');\n\n/**\n * Applies the `vulgarFractions` or `fractionSlash` options as necessary.\n */\nconst getFraction = (\n  vulgarFractionOrSixteenth: VulgarFraction | Sixteenth,\n  { fractionSlash, vulgarFractions }: ResolvedFormatQuantityOptions\n) => {\n  if (vulgarFractions) {\n    return vulgarFractionOrSixteenth;\n  }\n\n  const plainFraction: SimpleFraction =\n    vulgarToAsciiMap[vulgarFractionOrSixteenth as VulgarFraction] ?? vulgarFractionOrSixteenth;\n\n  if (fractionSlash) {\n    const [num, den] = plainFraction.split('/');\n    return `${toSuperscript(num)}⁄${toSubscript(den)}`;\n  }\n\n  return plainFraction;\n};\n\n/**\n * Only `false` (matching disabled) or a non-negative number is a valid\n * `tolerance`. Everything else—negative numbers, `NaN`, non-numbers,\n * `null`, `undefined`—resolves to {@link defaultTolerance}.\n */\nconst isValidTolerance = (tolerance: unknown): tolerance is number | false =>\n  tolerance === false || (typeof tolerance === 'number' && tolerance >= 0);\n\n/**\n * Merges options object with default options, converting boolean to object if necessary.\n */\nconst normalizeOptions = (\n  options: Parameters<FormatQuantity>[1]\n): ResolvedFormatQuantityOptions => {\n  const opts: ResolvedFormatQuantityOptions = {\n    ...defaultOptions,\n    ...(typeof options === 'boolean'\n      ? { vulgarFractions: options }\n      : typeof options === 'object' && options !== null\n        ? options\n        : {}),\n  };\n\n  if (!isValidTolerance(opts.tolerance)) {\n    opts.tolerance = defaultOptions.tolerance;\n  }\n\n  if (typeof opts.zeroFormat !== 'string') {\n    opts.zeroFormat = defaultOptions.zeroFormat;\n  }\n\n  if (opts.allowTrailingInvalid !== false) {\n    opts.allowTrailingInvalid = true;\n  }\n\n  return opts;\n};\n\n// oxfmt-ignore\nconst romanNumeralsByPlace = [\n  '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM',\n  '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC',\n  '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX',\n] as const;\n\n/**\n * Formats a number or bigint as Roman numerals. The number must be between\n * 1 and 3999, inclusive; any other value—including non-numbers,\n * `NaN`, and non-finite numbers—yields `null`.\n */\nexport const formatRomanNumerals = (quantity: number | bigint): string | null => {\n  if (\n    (typeof quantity !== 'number' && typeof quantity !== 'bigint') ||\n    !(quantity >= 1 && quantity < 4000)\n  ) {\n    return null;\n  }\n\n  const qty = Number(quantity);\n\n  const floored = Math.floor(qty);\n\n  const digits = `${floored}`.split('');\n  let roman = '';\n  let i = 3;\n  while (i--) {\n    roman = `${romanNumeralsByPlace[+digits.pop()! + i * 10] || ''}${roman}`;\n  }\n\n  return `${Array(+digits.join('') + 1).join('M')}${roman}`;\n};\n\n/**\n * Formats a number (or string that appears to be a number)\n * as one would see it written in imperial measurements, e.g.\n * \"1 1/2\" instead of \"1.5\". To use vulgar fraction characters\n * like \"½\", pass `true` as the second argument. For other options\n * see {@link FormatQuantityOptions}.\n */\nexport const formatQuantity: FormatQuantity = (qty, options) => {\n  // Only numbers, bigints, and strings are accepted. Anything else (objects, booleans,\n  // nullish, arrays like `[1]` that would coerce to a numeric string) is\n  // rejected up front so off-type inputs behave consistently.\n  if (typeof qty !== 'number' && typeof qty !== 'string' && typeof qty !== 'bigint') {\n    return null;\n  }\n\n  const opts = normalizeOptions(options);\n\n  const qtyAsNumber =\n    typeof qty !== 'number' && typeof qty !== 'bigint'\n      ? numericQuantity(qty, {\n          allowTrailingInvalid: opts.allowTrailingInvalid,\n          romanNumerals: opts.romanNumerals,\n          bigIntOnOverflow: true,\n          round: false,\n        })\n      : qty;\n\n  // Return `null` if input is not number-like.\n  if (typeof qtyAsNumber === 'number' && isNaN(qtyAsNumber)) {\n    return null;\n  }\n\n  // Return empty string (or configured `zeroFormat`) if the value is zero.\n  if (Number(qtyAsNumber) === 0) {\n    return opts.zeroFormat;\n  }\n\n  if (opts.romanNumerals) {\n    return formatRomanNumerals(qtyAsNumber);\n  }\n\n  const absoluteValue =\n    typeof qtyAsNumber === 'bigint'\n      ? qtyAsNumber < 0n\n        ? -qtyAsNumber\n        : qtyAsNumber\n      : Math.abs(qtyAsNumber);\n  const flooredAbsVal =\n    typeof absoluteValue === 'bigint' ? absoluteValue : Math.floor(absoluteValue);\n  const wholeNumberStr = `${flooredAbsVal || ''}`;\n  const decimalValue =\n    typeof absoluteValue === 'bigint' ? 0 : absoluteValue - (flooredAbsVal as number);\n\n  // For integers just return the given value as a string.\n  if (decimalValue === 0) {\n    return `${qtyAsNumber}`;\n  }\n\n  let closestMatch: VulgarFraction | Sixteenth | null = null;\n  let closestMatchDiff = Infinity;\n  // `tolerance: false` disables fraction matching entirely.\n  if (opts.tolerance !== false) {\n    for (const [num, vf] of fractionDecimalMatches) {\n      const diff = Math.abs(decimalValue - num);\n      // `diff === 0` keeps exact quotients matching even at `tolerance: 0`.\n      if (diff < opts.tolerance || diff === 0) {\n        if (diff === 0) {\n          closestMatch = vf;\n          break;\n        }\n        if (diff < closestMatchDiff) {\n          closestMatch = vf;\n          closestMatchDiff = diff;\n        }\n      }\n    }\n  }\n\n  if (closestMatch) {\n    const fraction = getFraction(closestMatch, opts);\n    const isVulgar = fraction in vulgarToAsciiMap;\n    const sep = wholeNumberStr ? (opts.separator ?? (isVulgar ? '' : ' ')) : '';\n    return `${qtyAsNumber < 0 ? '-' : ''}${wholeNumberStr}${sep}${fraction}`;\n  }\n\n  return `${qtyAsNumber}`;\n};\n"],"mappings":"mDAWA,MAAa,EAAmB,MAKnB,EAA0D,OAAO,OAAO,CACnF,gBAAiB,GACjB,UAAW,EACX,cAAe,GACf,cAAe,GACf,WAAY,GACZ,qBAAsB,EACxB,CAAC,EAKY,EAAqE,OAAO,OAAO,CAC9F,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,OACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,MACL,IAAK,KACP,CAAC,EAOY,EACX,OAAO,OAEH,CACE,CAAC,EAAI,GAAI,MAAM,EACf,CAAC,EAAI,GAAI,GAAG,EACZ,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,GAAI,MAAM,EACf,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,GAAI,MAAM,EACf,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,GAAI,MAAM,EACf,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,GAAI,MAAM,EACf,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,GAAK,GAAI,OAAO,EACjB,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,GAAK,GAAI,OAAO,EACjB,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,EAAI,EAAG,GAAG,EACX,CAAC,GAAK,GAAI,OAAO,CACnB,CAAC,CACD,IAAI,GAAS,OAAO,OAAO,CAAK,CAAC,CACrC,ECxEI,EAAiB,GAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAK,aAAkB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,EAE7E,EAAe,GAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAK,aAAgB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,EAKzE,GACJ,EACA,CAAE,gBAAe,qBACd,CACH,GAAI,EACF,OAAO,EAGT,IAAM,EACJ,EAAiB,IAAgD,EAEnE,GAAI,EAAe,CACjB,GAAM,CAAC,EAAK,GAAO,EAAc,MAAM,GAAG,EAC1C,MAAO,GAAG,EAAc,CAAG,EAAE,GAAG,EAAY,CAAG,GACjD,CAEA,OAAO,CACT,EAOM,EAAoB,GACxB,IAAc,IAAU,OAAO,GAAc,UAAY,GAAa,EAKlE,EACJ,GACkC,CAClC,IAAM,EAAsC,CAC1C,GAAG,EACH,GAAI,OAAO,GAAY,UACnB,CAAE,gBAAiB,CAAQ,EAC3B,OAAO,GAAY,UAAY,EAC7B,EACA,CAAC,CACT,EAcA,OAZK,EAAiB,EAAK,SAAS,IAClC,EAAK,UAAY,EAAe,WAG9B,OAAO,EAAK,YAAe,WAC7B,EAAK,WAAa,EAAe,YAG/B,EAAK,uBAAyB,KAChC,EAAK,qBAAuB,IAGvB,CACT,EAGM,EAAuB,qGAI7B,EAOa,EAAuB,GAA6C,CAC/E,GACG,OAAO,GAAa,UAAY,OAAO,GAAa,UACrD,EAAE,GAAY,GAAK,EAAW,KAE9B,OAAO,KAGT,IAAM,EAAM,OAAO,CAAQ,EAIrB,EAAS,GAFC,KAAK,MAAM,CAEH,IAAI,MAAM,EAAE,EAChC,EAAQ,GACR,EAAI,EACR,KAAO,KACL,EAAQ,GAAG,EAAqB,CAAC,EAAO,IAAI,EAAK,EAAI,KAAO,KAAK,IAGnE,MAAO,GAAG,MAAM,CAAC,EAAO,KAAK,EAAE,EAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,GACpD,EASa,GAAkC,EAAK,IAAY,CAI9D,GAAI,OAAO,GAAQ,UAAY,OAAO,GAAQ,UAAY,OAAO,GAAQ,SACvE,OAAO,KAGT,IAAM,EAAO,EAAiB,CAAO,EAE/B,EACJ,OAAO,GAAQ,UAAY,OAAO,GAAQ,SACtC,EAAgB,EAAK,CACnB,qBAAsB,EAAK,qBAC3B,cAAe,EAAK,cACpB,iBAAkB,GAClB,MAAO,EACT,CAAC,EACD,EAGN,GAAI,OAAO,GAAgB,UAAY,MAAM,CAAW,EACtD,OAAO,KAIT,GAAI,OAAO,CAAW,IAAM,EAC1B,OAAO,EAAK,WAGd,GAAI,EAAK,cACP,OAAO,EAAoB,CAAW,EAGxC,IAAM,EACJ,OAAO,GAAgB,SACnB,EAAc,GACZ,CAAC,EACD,EACF,KAAK,IAAI,CAAW,EACpB,EACJ,OAAO,GAAkB,SAAW,EAAgB,KAAK,MAAM,CAAa,EACxE,EAAiB,GAAG,GAAiB,KACrC,EACJ,OAAO,GAAkB,SAAW,EAAI,EAAiB,EAG3D,GAAI,IAAiB,EACnB,MAAO,GAAG,IAGZ,IAAI,EAAkD,KAClD,EAAmB,IAEvB,GAAI,EAAK,YAAc,GACrB,IAAK,GAAM,CAAC,EAAK,KAAO,EAAwB,CAC9C,IAAM,EAAO,KAAK,IAAI,EAAe,CAAG,EAExC,GAAI,EAAO,EAAK,WAAa,IAAS,EAAG,CACvC,GAAI,IAAS,EAAG,CACd,EAAe,EACf,KACF,CACI,EAAO,IACT,EAAe,EACf,EAAmB,EAEvB,CACF,CAGF,GAAI,EAAc,CAChB,IAAM,EAAW,EAAY,EAAc,CAAI,EACzC,EAAW,KAAY,EACvB,EAAM,EAAkB,EAAK,YAAc,EAAW,GAAK,KAAQ,GACzE,MAAO,GAAG,EAAc,EAAI,IAAM,KAAK,IAAiB,IAAM,GAChE,CAEA,MAAO,GAAG,GACZ"}

package/dist/format-quantity.umd.min.js

@@ -0,0 +1,3 @@
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.FormatQuantity={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});let t=.0075,n=Object.freeze({vulgarFractions:!1,tolerance:t,fractionSlash:!1,romanNumerals:!1,zeroFormat:``,allowTrailingInvalid:!0}),r=Object.freeze({"¼":`1/4`,"½":`1/2`,"¾":`3/4`,"⅐":`1/7`,"⅑":`1/9`,"⅒":`1/10`,"⅓":`1/3`,"⅔":`2/3`,"⅕":`1/5`,"⅖":`2/5`,"⅗":`3/5`,"⅘":`4/5`,"⅙":`1/6`,"⅚":`5/6`,"⅛":`1/8`,"⅜":`3/8`,"⅝":`5/8`,"⅞":`7/8`}),i=Object.freeze([[1/16,`1/16`],[1/10,`⅒`],[1/9,`⅑`],[1/8,`⅛`],[1/7,`⅐`],[1/6,`⅙`],[3/16,`3/16`],[1/5,`⅕`],[1/4,`¼`],[5/16,`5/16`],[1/3,`⅓`],[3/8,`⅜`],[2/5,`⅖`],[7/16,`7/16`],[1/2,`½`],[9/16,`9/16`],[3/5,`⅗`],[5/8,`⅝`],[2/3,`⅔`],[11/16,`11/16`],[3/4,`¾`],[4/5,`⅘`],[13/16,`13/16`],[5/6,`⅚`],[7/8,`⅞`],[15/16,`15/16`]].map(e=>Object.freeze(e))),a=[48,1632,1776,1984,2406,2534,2662,2790,2918,3046,3174,3302,3430,3558,3664,3792,3872,4160,4240,6112,6160,6470,6608,6784,6800,6992,7088,7232,7248,42528,43216,43264,43472,43504,43600,44016,65296,66720,68912,68928,69734,69872,69942,70096,70384,70736,70864,71248,71360,71376,71386,71472,71904,72016,72688,72784,73040,73120,73184,73552,90416,92768,92864,93008,93552,118e3,120782,120792,120802,120812,120822,123200,123632,124144,124401,125264,130032],o=e=>e.replace(/\p{Nd}/gu,e=>{let t=e.codePointAt(0);if(t<=57)return e;let n=0,r=a.length-1;for(;n<r;){let e=n+r+1>>>1;a[e]<=t?n=e:r=e-1}return String(t-a[n])}),s={"⁰":`0`,"¹":`1`,"²":`2`,"³":`3`,"⁴":`4`,"⁵":`5`,"⁶":`6`,"⁷":`7`,"⁸":`8`,"⁹":`9`,"₀":`0`,"₁":`1`,"₂":`2`,"₃":`3`,"₄":`4`,"₅":`5`,"₆":`6`,"₇":`7`,"₈":`8`,"₉":`9`},c=/[⁰¹²³⁴⁵⁶⁷⁸⁹₀₁₂₃₄₅₆₇₈₉]/g,l={"¼":`1/4`,"½":`1/2`,"¾":`3/4`,"⅐":`1/7`,"⅑":`1/9`,"⅒":`1/10`,"⅓":`1/3`,"⅔":`2/3`,"⅕":`1/5`,"⅖":`2/5`,"⅗":`3/5`,"⅘":`4/5`,"⅙":`1/6`,"⅚":`5/6`,"⅛":`1/8`,"⅜":`3/8`,"⅝":`5/8`,"⅞":`7/8`,"⅟":`1/`},u=/^(?=[-+]?\s*\.\d|[-+]?\s*\d)([-+])?\s*((?:\d(?:[,_]\d|\d)*)*)(([eE][+-]?\d(?:[,_]\d|\d)*)?|\.\d(?:[,_]\d|\d)*([eE][+-]?\d(?:[,_]\d|\d)*)?|(\s+\d(?:[,_]\d|\d)*\s*)?\s*\/\s*\d(?:[,_]\d|\d)*)?(\s*[^.\d/].*)?/,d=/([¼½¾⅐⅑⅒⅓⅔⅕⅖⅗⅘⅙⅚⅛⅜⅝⅞⅟])/g,f={MMM:3e3,MM:2e3,M:1e3,CM:900,DCCC:800,DCC:700,DC:600,D:500,CD:400,CCC:300,CC:200,C:100,XC:90,LXXX:80,LXX:70,LX:60,L:50,XL:40,XXX:30,XX:20,XII:12,XI:11,X:10,IX:9,VIII:8,VII:7,VI:6,V:5,IV:4,III:3,II:2,I:1},p={Ⅰ:`I`,Ⅱ:`II`,Ⅲ:`III`,Ⅳ:`IV`,Ⅴ:`V`,Ⅵ:`VI`,Ⅶ:`VII`,Ⅷ:`VIII`,Ⅸ:`IX`,Ⅹ:`X`,Ⅺ:`XI`,Ⅻ:`XII`,Ⅼ:`L`,Ⅽ:`C`,Ⅾ:`D`,Ⅿ:`M`,ⅰ:`I`,ⅱ:`II`,ⅲ:`III`,ⅳ:`IV`,ⅴ:`V`,ⅵ:`VI`,ⅶ:`VII`,ⅷ:`VIII`,ⅸ:`IX`,ⅹ:`X`,ⅺ:`XI`,ⅻ:`XII`,ⅼ:`L`,ⅽ:`C`,ⅾ:`D`,ⅿ:`M`},m=/([ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅬⅭⅮⅯⅰⅱⅲⅳⅴⅵⅶⅷⅸⅹⅺⅻⅼⅽⅾⅿ])/gi,h=/^(?=[MDCLXVI])(M{0,3})(C[MD]|D?C{0,3})(X[CL]|L?X{0,3})(I[XV]|V?I{0,3})$/i,g={round:3,allowTrailingInvalid:!1,romanNumerals:!1,bigIntOnOverflow:!1,decimalSeparator:`.`,allowCurrency:!1,percentage:!1,verbose:!1},_=e=>{let t=e.replace(m,(e,t)=>p[t]).toUpperCase(),n=h.exec(t);if(!n)return NaN;let[,r,i,a,o]=n;return(f[r]??0)+(f[i]??0)+(f[a]??0)+(f[o]??0)},v=/^\s*\//,y=/^([-+]?)\s*(\p{Sc}+)\s*/u,b=/\s*(\p{Sc}+)\s*$/u,x=/\s*%$/,S=BigInt(2**53-1),C=e=>10n**BigInt(e),w=(e,t,n)=>{let r,i=1n;if(!t)r=BigInt(e);else if(t.startsWith(`.`)||t.startsWith(`e`)||t.startsWith(`E`)){let n=t.search(/[eE]/),a=n===-1?0:parseInt(t.slice(n+1));if(!Number.isFinite(a)||Math.abs(a)>1e4)return;let o=(n===-1?t:t.slice(0,n)).slice(1);r=BigInt(`${e}${o}`),o&&(i=C(o.length)),a>0?r*=C(a):a<0&&(i*=C(-a))}else if(v.test(t))r=BigInt(e),i=BigInt(t.replace(`/`,``).trim());else{let[n,a]=t.split(`/`);i=BigInt(a.trim()),r=BigInt(e)*i+BigInt(n.trim())}if(n&&(i*=100n),i===0n)return;let a=(2n*r+i)/(2n*i);return a>S?a:void 0};function T(e,t=g){let n={...g,...t},r;if(typeof e==`string`)r=e;else try{r=String(e)}catch{r=``}let i,a,f,p,m,h,S,C,T=e=>{let t={value:e,input:r};return i&&(t.currencyPrefix=i),a&&(t.currencySuffix=a),f&&(t.percentageSuffix=f),p&&(t.trailingInvalid=p),m&&(t.sign=m),h!==void 0&&(t.whole=h),S!==void 0&&(t.numerator=S),C!==void 0&&(t.denominator=C),t},E=e=>n.verbose?T(e):e,D=e=>f&&n.percentage!==`number`?e/100:e;if(typeof e==`symbol`)return E(NaN);if(typeof e==`number`||typeof e==`bigint`)return E(e);let O=NaN,k=r,A=!0;for(;A;){if(A=!1,n.allowCurrency){let e=y.exec(k);e?.[2]&&(i=(i??``)+e[2],k=(e[1]||``)+k.slice(e[0].length),A=!0);let t=b.exec(k);t&&(a=t[1]+(a??``),k=k.slice(0,-t[0].length),A=!0)}if(!f&&n.percentage){let e=x.exec(k);e&&(f=!0,k=k.slice(0,-e[0].length),A=!0)}}let j=o(k.replace(d,(e,t)=>` ${l[t]}`).replace(c,e=>s[e]).replace(`⁄`,`/`).trim());if(j.length===0)return E(NaN);let M=j;if(n.decimalSeparator===`,`){let e=(j.match(/,/g)||[]).length;if(e===1)M=j.replaceAll(`.`,`_`).replace(`,`,`.`);else if(e>1){let e=j.indexOf(`,`),t=j.indexOf(`,`,e+1);M=j.substring(0,t).replaceAll(`.`,`_`).replace(`,`,`.`)}else M=j.replaceAll(`.`,`_`)}let N=u.exec(M);if(!N)return n.romanNumerals?E(D(_(j))):E(NaN);let P=N[0].length-(N[7]?.length??0),F=j.slice(P).trim();if(F&&(p=F,!n.allowTrailingInvalid))return E(NaN);let[,I,L,R]=N;(I===`-`||I===`+`)&&(m=I);let z=L.replaceAll(`,`,``).replaceAll(`_`,``),B=R?.replaceAll(`,`,``).replaceAll(`_`,``);if(n.bigIntOnOverflow){let e=w(z,B,!!f&&n.percentage!==`number`);if(e!==void 0)return E(I===`-`?-e:e)}if(O=!z&&B&&B.startsWith(`.`)?0:parseInt(z),!B)return O=I===`-`?O*-1:O,E(D(O));let V=typeof n.round==`number`&&Number.isFinite(n.round)?Math.floor(Math.max(0,n.round)):!1,H=V===!1?NaN:10**V,U=Number.isFinite(H)?H:NaN,W=(e,t)=>{let n=Math.round(t)/U;return Number.isFinite(n)||!Number.isFinite(e)?n:e};if(B.startsWith(`.`)||B.startsWith(`e`)||B.startsWith(`E`)){let e=parseFloat(`${O}${B}`);O=isNaN(U)?e:W(e,e*U)}else if(v.test(B)){let e=parseInt(z),t=parseInt(B.replace(`/`,``));S=e,C=t,O=isNaN(U)?e/t:W(e/t,e*U/t)}else{let[e,t]=B.split(`/`).map(e=>parseInt(e));h=O,S=e,C=t,O+=isNaN(U)?e/t:W(e/t,e*U/t)}return O=I===`-`?O*-1:O,E(D(O))}let E=e=>[...e].map(e=>`⁰¹²³⁴⁵⁶⁷⁸⁹`[+e]).join(``),D=e=>[...e].map(e=>`₀₁₂₃₄₅₆₇₈₉`[+e]).join(``),O=(e,{fractionSlash:t,vulgarFractions:n})=>{if(n)return e;let i=r[e]??e;if(t){let[e,t]=i.split(`/`);return`${E(e)}⁄${D(t)}`}return i},k=e=>e===!1||typeof e==`number`&&e>=0,A=e=>{let t={...n,...typeof e==`boolean`?{vulgarFractions:e}:typeof e==`object`&&e?e:{}};return k(t.tolerance)||(t.tolerance=n.tolerance),typeof t.zeroFormat!=`string`&&(t.zeroFormat=n.zeroFormat),t.allowTrailingInvalid!==!1&&(t.allowTrailingInvalid=!0),t},j=`.C.CC.CCC.CD.D.DC.DCC.DCCC.CM..X.XX.XXX.XL.L.LX.LXX.LXXX.XC..I.II.III.IV.V.VI.VII.VIII.IX`.split(`.`),M=e=>{if(typeof e!=`number`&&typeof e!=`bigint`||!(e>=1&&e<4e3))return null;let t=Number(e),n=`${Math.floor(t)}`.split(``),r=``,i=3;for(;i--;)r=`${j[+n.pop()+i*10]||``}${r}`;return`${Array(+n.join(``)+1).join(`M`)}${r}`};e.defaultOptions=n,e.defaultTolerance=t,e.formatQuantity=(e,t)=>{if(typeof e!=`number`&&typeof e!=`string`&&typeof e!=`bigint`)return null;let n=A(t),a=typeof e!=`number`&&typeof e!=`bigint`?T(e,{allowTrailingInvalid:n.allowTrailingInvalid,romanNumerals:n.romanNumerals,bigIntOnOverflow:!0,round:!1}):e;if(typeof a==`number`&&isNaN(a))return null;if(Number(a)===0)return n.zeroFormat;if(n.romanNumerals)return M(a);let o=typeof a==`bigint`?a<0n?-a:a:Math.abs(a),s=typeof o==`bigint`?o:Math.floor(o),c=`${s||``}`,l=typeof o==`bigint`?0:o-s;if(l===0)return`${a}`;let u=null,d=1/0;if(n.tolerance!==!1)for(let[e,t]of i){let r=Math.abs(l-e);if(r<n.tolerance||r===0){if(r===0){u=t;break}r<d&&(u=t,d=r)}}if(u){let e=O(u,n),t=e in r,i=c?n.separator??(t?``:` `):``;return`${a<0?`-`:``}${c}${i}${e}`}return`${a}`},e.formatRomanNumerals=M,e.fractionDecimalMatches=i,e.vulgarToAsciiMap=r});
+typeof window<"u"&&typeof exports=="object"&&(window.FormatQuantity=exports);
+//# sourceMappingURL=format-quantity.umd.min.js.map