@zinaid/num 0.0.5 → 0.0.7

package/dist/index.js

@@ -1,7 +1,7 @@
-import { clamp as a, currency as l, defaultCurrency as o, defaultLocale as n, fileSize as s, forHumans as u, format as t, minutesToHuman as c, ordinal as m, pairs as p, parse as i, parseFloat as f, parseInt as d, percentage as y, secondsToHuman as C, spell as H, spellOrdinal as L, summarize as h, trim as w, useCurrency as x, useLocale as z, withCurrency as S, withLocale as T } from "./num.js";
-import { Speller as F } from "./speller.js";
+import { clamp as a, currency as l, defaultCurrency as o, defaultLocale as n, fileSize as s, forHumans as u, format as t, minutesToHuman as c, ordinal as m, pairs as p, parse as i, parseFloat as f, parseInt as d, percentage as y, secondsToHuman as C, summarize as H, trim as L, useCurrency as h, useLocale as w, withCurrency as x, withLocale as z } from "./num.js";
+import { Speller as T, spell as g, spellOrdinal as F } from "./speller/index.js";
 export {
-  F as Speller,
+  T as Speller,
   a as clamp,
   l as currency,
   o as defaultCurrency,
@@ -17,12 +17,12 @@ export {
   d as parseInt,
   y as percentage,
   C as secondsToHuman,
-  H as spell,
-  L as spellOrdinal,
-  h as summarize,
-  w as trim,
-  x as useCurrency,
-  z as useLocale,
-  S as withCurrency,
-  T as withLocale
+  g as spell,
+  F as spellOrdinal,
+  H as summarize,
+  L as trim,
+  h as useCurrency,
+  w as useLocale,
+  x as withCurrency,
+  z as withLocale
 };

package/dist/num.d.ts

@@ -1,6 +1,12 @@
 /**
  * Format the given number according to the current locale.
  *
+ * @param number The number to format.
+ * @param precision The number of decimal places to use.
+ * @param maxPrecision The maximum number of decimal places to use.
+ * @param locale The locale to use for formatting.
+ * @returns The formatted number string.
+ *
  * @example
  *
  * format(1234.5678, 2); // "1,234.57"
@@ -11,6 +17,10 @@ export declare function format(number: number, precision?: number | null, maxPre
 /**
  * Parse the given string according to the specified format type.
  *
+ * @param value The string to parse.
+ * @param locale The locale to use for parsing.
+ * @returns The parsed number.
+ *
  * @example
  *
  * parse("1,234.57"); // 1234.57
@@ -19,6 +29,10 @@ export declare function parse(value: string, locale?: string | null): number;
 /**
  * Parse a string into an integer according to the specified locale.
  *
+ * @param value The string to parse.
+ * @param locale The locale to use for parsing.
+ * @returns The parsed integer or false if parsing fails.
+ *
  * @example
  *
  * parseInt("1,234", "en"); // 1234
@@ -27,19 +41,18 @@ export declare function parseInt(value: string, locale?: string | null): number
 /**
  * Parse a string into a float according to the specified locale.
  *
- * @param  string  $string
- * @param  string|null  $locale
- * @return float|false
+ * @param value The string to parse.
+ * @param locale The locale to use for parsing.
+ * @returns The parsed float or false if parsing fails.
  */
 export declare function parseFloat(value: string, locale?: string | null): number | false;
-/**
- * Spell out the given number in the given locale.
- * @todo
- */
-export declare function spell(_number: number | string, _locale?: string | null, _after?: number | null, _until?: number | null): string;
 /**
  * Convert the given number to ordinal form.
  *
+ * @param value The number to convert.
+ * @param locale The locale to use for determining ordinal rules.
+ * @returns The number in ordinal form.
+ *
  * @example
  *
  * ordinal(1); // "1st"
@@ -48,20 +61,15 @@ export declare function spell(_number: number | string, _locale?: string | null,
  * ordinal(13); // "13th"
  */
 export declare function ordinal(value: number, locale?: string | null): string;
-/**
- * Spell out the given number in the given locale in ordinal form.
- * @todo
- *
- * @example
- *
- * spellOrdinal(1); // "first"
- * spellOrdinal(2); // "second"
- * spellOrdinal(3); // "third"
- */
-export declare function spellOrdinal(_value: number, _locale?: string | null): string;
 /**
  * Convert the given number to its percentage equivalent.
  *
+ * @param number The number to convert.
+ * @param precision The number of decimal places to use.
+ * @param maxPrecision The maximum number of decimal places to use.
+ * @param locale The locale to use for formatting.
+ * @returns The formatted percentage string.
+ *
  * @example
  *
  * percentage(1); // "1%"
@@ -72,6 +80,12 @@ export declare function percentage(number: number | string, precision?: number,
 /**
  * Convert the given number to its currency equivalent.
  *
+ * @param amount The amount to convert.
+ * @param currencyCode The currency code to use (e.g. "USD", "EUR").
+ * @param locale The locale to use for formatting.
+ * @param precision The number of decimal places to use.
+ * @returns The formatted currency string.
+ *
  * @example
  *
  * currency(5.00); // "$5.00"
@@ -82,6 +96,11 @@ export declare function currency(amount: number | string, currencyCode?: string,
 /**
  * Convert the given number to its file size equivalent.
  *
+ * @param bytes The number of bytes.
+ * @param precision The number of decimal places to use.
+ * @param maxPrecision The maximum number of decimal places to use.
+ * @returns The formatted file size string.
+ *
  * @example
  *
  * fileSize(1024); // "1 KB"
@@ -92,6 +111,10 @@ export declare function fileSize(bytes: number | string, precision?: number, max
 /**
  * Convert the number to its human-readable equivalent.
  *
+ * @param value The number to convert.
+ * @param precision The number of decimal places to use.
+ * @param maxPrecision The maximum number of decimal places to use.
+ *
  * @example
  *
  * forHumans(1234); // "1.234 thousand"
@@ -102,6 +125,12 @@ export declare function forHumans(value: number, precision?: number, maxPrecisio
 /**
  * Convert the number to its human-readable equivalent.
  *
+ * @param value The number to convert.
+ * @param precision The number of decimal places to use.
+ * @param maxPrecision The maximum number of decimal places to use.
+ * @param units Custom units mapping (exponent to suffix).
+ * @returns The summarized number string.
+ *
  * @example
  *
  * summarize(1234); // "1.234 K"
@@ -112,6 +141,11 @@ export declare function summarize(value: number, precision?: number, maxPrecisio
 /**
  * Clamp the given number between the given minimum and maximum.
  *
+ * @param value The number to clamp.
+ * @param min The minimum value.
+ * @param max The maximum value.
+ * @returns The clamped number.
+ *
  * @example
  *
  * clamp(5, 1, 10); // 5
@@ -122,6 +156,12 @@ export declare function clamp(value: number, min: number, max: number): number;
 /**
  * Split the given number into pairs of min/max values.
  *
+ * @param to The maximum value.
+ * @param by The size of each pair.
+ * @param start The starting value.
+ * @param offset The offset to apply to the upper bound of each pair.
+ * @returns An array of [min, max] pairs.
+ *
  * @example
  *
  * pairs(25, 10, 1, 1); // [[1, 11], [11, 21], [21, 25]]
@@ -130,6 +170,9 @@ export declare function pairs(to: number, by: number, start?: number, offset?: n
 /**
  * Remove any trailing zero digits after the decimal point of the given number.
  *
+ * @param value The number to trim.
+ * @returns The trimmed number.
+ *
  * @example
  *
  * trim(12.3456789); // 12.3456789
@@ -165,6 +208,10 @@ export declare function secondsToHuman(seconds: number | string, round?: boolean
 /**
  * Execute the given callback using the given locale.
  *
+ * @param locale The locale to use.
+ * @param callback The callback to execute.
+ * @returns The result of the callback.
+ *
  * @example
  *
  * withLocale("fr", () => {
@@ -175,6 +222,10 @@ export declare function withLocale(locale: string, callback: () => unknown): unk
 /**
  * Execute the given callback using the given currency.
  *
+ * @param currency The currency to use.
+ * @param callback The callback to execute.
+ * @returns The result of the callback.
+ *
  * @example
  *
  * withCurrency("EUR", () => {
@@ -184,18 +235,36 @@ export declare function withLocale(locale: string, callback: () => unknown): unk
 export declare function withCurrency(currency: string, callback: () => unknown): unknown;
 /**
  * Set the default locale.
+ *
+ * @param locale The locale to set.
+ * @returns void
  */
 export declare function useLocale(locale: string): void;
 /**
  * Set the default currency.
+ *
+ * @param currency The currency to set.
+ * @returns void
  */
 export declare function useCurrency(currency: string): void;
 /**
  * Get the default locale.
+ *
+ * @returns The default locale.
+ *
+ * @example
+ *
+ * defaultLocale(); // "en"
  */
 export declare function defaultLocale(): string;
 /**
  * Get the default currency.
+ *
+ * @returns The default currency.
+ *
+ * @example
+ *
+ * defaultCurrency(); // "USD"
  */
 export declare function defaultCurrency(): string;
 //# sourceMappingURL=num.d.ts.map

package/dist/num.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"num.d.ts","sourceRoot":"","sources":["../src/num.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAClB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAmBhB;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,CA2DzE;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAQhB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAEhB;AAED;;;GAGG;AACH,wBAAgB,KAAK,CACjB,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,CAMR;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,CAwC3E;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CACxB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAAM,GAAG,IAAW,GAC9B,MAAM,CAIR;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACtB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAqBhB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACpB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,YAAY,GAAE,MAAW,EACzB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,MAAM,GAAG,KAAK,CAiBhB;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,GACnC,MAAM,CA6BR;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACrB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,UAAU,GAAE,OAAe,GAC5B,MAAM,GAAG,KAAK,CAehB;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACrB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACnC,MAAM,GAAG,KAAK,CA4EhB;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACjB,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,MAAU,EACjB,MAAM,GAAE,MAAU,GACnB,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAcpB;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,GAAE,OAAc,GACtB,MAAM,CAIR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,GAAE,OAAc,GACtB,MAAM,CAoDR;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,GAAG,OAAO,CAU3E;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,OAAO,GACxB,OAAO,CAUT;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAElD;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC"}
+{"version":3,"file":"num.d.ts","sourceRoot":"","sources":["../src/num.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,CAClB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAmBhB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,CA2DzE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAQhB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAEhB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,CAwC3E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CACtB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,GAAG,KAAK,CAqBhB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACpB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,YAAY,GAAE,MAAW,EACzB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,MAAM,GAAG,KAAK,CAiBhB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,GACnC,MAAM,CA6BR;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACrB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,UAAU,GAAE,OAAe,GAC5B,MAAM,GAAG,KAAK,CAehB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACrB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAU,EACrB,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACnC,MAAM,GAAG,KAAK,CA4EhB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CACjB,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,MAAU,EACjB,MAAM,GAAE,MAAU,GACnB,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAcpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,GAAE,OAAc,GACtB,MAAM,CAIR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,KAAK,GAAE,OAAc,GACtB,MAAM,CAoDR;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,GAAG,OAAO,CAU3E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,OAAO,GACxB,OAAO,CAUT;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAElD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC"}

package/dist/num.js

@@ -10,27 +10,27 @@ function g(t, n = null, e = null, r = null) {
 function $(t, n = null) {
   n = n ?? m;
   const r = new Intl.NumberFormat(n).formatToParts(12345.6), o = /* @__PURE__ */ new Set();
-  let s = ".";
+  let l = ".";
   for (const i of r)
-    i.type === "group" ? o.add(i.value) : i.type === "decimal" && (s = i.value);
-  const u = [" ", " ", " "];
-  for (const i of u) o.add(i);
-  let l = t;
+    i.type === "group" ? o.add(i.value) : i.type === "decimal" && (l = i.value);
+  const s = [" ", " ", " "];
+  for (const i of s) o.add(i);
+  let u = t;
   for (const i of o) {
     const c = new RegExp(
       i.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"),
       "g"
     );
-    l = l.replace(c, "");
+    u = u.replace(c, "");
   }
-  if (s !== ".") {
+  if (l !== ".") {
     const i = new RegExp(
-      s.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"),
+      l.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"),
       "g"
-    ), c = l.lastIndexOf(s);
-    c !== -1 && (l = l.slice(0, c).replace(i, "") + "." + l.slice(c + s.length));
+    ), c = u.lastIndexOf(l);
+    c !== -1 && (u = u.slice(0, c).replace(i, "") + "." + u.slice(c + l.length));
   }
-  return l = l.replace(/[\s\u00A0\u202F\u2009]+/g, "").trim(), globalThis.Number(l);
+  return u = u.replace(/[\s\u00A0\u202F\u2009]+/g, "").trim(), globalThis.Number(u);
 }
 function S(t, n = null) {
   const e = $(t, n);
@@ -39,15 +39,12 @@ function S(t, n = null) {
 function x(t, n = null) {
   return $(t, n);
 }
-function E(t, n = null, e = null, r = null) {
-  return "";
-}
-function O(t, n = null) {
+function E(t, n = null) {
   const e = n ?? m;
   try {
-    const o = new Intl.PluralRules(e, { type: "ordinal" }).select(t), s = e.split("-")[0] || "en", u = {
+    const o = new Intl.PluralRules(e, { type: "ordinal" }).select(t), l = e.split("-")[0] || "en", s = {
       en: { one: "st", two: "nd", few: "rd", other: "th" }
-    }, l = u[s] ?? u.en, p = l[o] ?? l.other;
+    }, u = s[l] ?? s.en, p = u[o] ?? u.other;
     return `${t}${p}`;
   } catch {
     const r = Math.abs(t), o = r % 100;
@@ -65,25 +62,22 @@ function O(t, n = null) {
     }
   }
 }
-function B(t, n = null) {
-  return "";
-}
-function I(t, n = 0, e = null, r = null) {
-  const o = r ?? m, s = typeof t == "string" ? $(t, o) : t, u = {
+function B(t, n = 0, e = null, r = null) {
+  const o = r ?? m, l = typeof t == "string" ? $(t, o) : t, s = {
     style: "percent",
     useGrouping: !0
   };
-  return e != null ? (u.maximumFractionDigits = e, u.minimumFractionDigits = 0) : (u.minimumFractionDigits = n, u.maximumFractionDigits = n), new Intl.NumberFormat(o, u).format(s / 100);
+  return e != null ? (s.maximumFractionDigits = e, s.minimumFractionDigits = 0) : (s.minimumFractionDigits = n, s.maximumFractionDigits = n), new Intl.NumberFormat(o, s).format(l / 100);
 }
-function T(t, n = "", e = null, r = null) {
-  const o = e ?? m, s = typeof t == "string" ? $(t, o) : t, l = {
+function O(t, n = "", e = null, r = null) {
+  const o = e ?? m, l = typeof t == "string" ? $(t, o) : t, u = {
     style: "currency",
     currency: n && n.length ? n : y,
     useGrouping: !0
   };
-  return r != null && (l.minimumFractionDigits = r, l.maximumFractionDigits = r), new Intl.NumberFormat(o, l).format(s);
+  return r != null && (u.minimumFractionDigits = r, u.maximumFractionDigits = r), new Intl.NumberFormat(o, u).format(l);
 }
-function _(t, n = 0, e = null) {
+function I(t, n = 0, e = null) {
   let r = typeof t == "string" ? Number(t) : t;
   Number.isFinite(r) || (r = 0);
   const o = [
@@ -96,13 +90,13 @@ function _(t, n = 0, e = null) {
     "EB",
     "ZB",
     "YB"
-  ], s = o.length;
-  let u = 0;
-  for (; r / 1024 > 0.9 && u < s - 1; )
-    r /= 1024, u++;
-  return `${g(r, n, e)} ${o[u]}`;
+  ], l = o.length;
+  let s = 0;
+  for (; r / 1024 > 0.9 && s < l - 1; )
+    r /= 1024, s++;
+  return `${g(r, n, e)} ${o[s]}`;
 }
-function R(t, n = 0, e = null, r = !1) {
+function T(t, n = 0, e = null, r = !1) {
   return b(
     t,
     n,
@@ -141,46 +135,46 @@ function b(t, n = 0, e = null, r = {}) {
       r
     )}${h}`.trim();
   }
-  const o = Math.floor(Math.log10(t)), s = o - o % 3, u = t / Math.pow(10, s);
-  let l;
+  const o = Math.floor(Math.log10(t)), l = o - o % 3, s = t / Math.pow(10, l);
+  let u;
   if (e != null)
-    l = g(u, null, e);
+    u = g(s, null, e);
   else if (n > 0)
-    l = g(u, n, null);
+    u = g(s, n, null);
   else {
     const i = Math.abs(t);
-    l = s === 3 && u < 10 && i % 10 === 0 ? g(u, null, 1) : g(u, 0, null);
+    u = l === 3 && s < 10 && i % 10 === 0 ? g(s, null, 1) : g(s, 0, null);
   }
-  const p = r[s] ?? "";
-  return `${l}${p}`.trim();
+  const p = r[l] ?? "";
+  return `${u}${p}`.trim();
 }
-function G(t, n, e) {
+function R(t, n, e) {
   return Math.min(Math.max(t, n), e);
 }
-function H(t, n, e = 0, r = 1) {
+function G(t, n, e = 0, r = 1) {
   const o = [];
-  for (let s = e; s < t; s += n) {
-    let u = s + n - r;
-    u > t && (u = t), o.push([s, u]);
+  for (let l = e; l < t; l += n) {
+    let s = l + n - r;
+    s > t && (s = t), o.push([l, s]);
   }
   return o;
 }
-function k(t) {
+function H(t) {
   return JSON.parse(JSON.stringify(t));
 }
-function A(t, n = !0) {
+function k(t, n = !0) {
   const e = Number(t) * 60;
   return D(e, n);
 }
 function D(t, n = !0) {
   let e = Number(t);
   if ((!Number.isFinite(e) || e < 0) && (e = 0), e === 0) return "0 seconds";
-  const r = 1, o = 60 * r, s = 60 * o, u = 24 * s, l = 7 * u, p = 4 * l, c = [
+  const r = 1, o = 60 * r, l = 60 * o, s = 24 * l, u = 7 * s, p = 4 * u, c = [
     ["year", 12 * p],
     ["month", p],
-    ["week", l],
-    ["day", u],
-    ["hour", s],
+    ["week", u],
+    ["day", s],
+    ["hour", l],
     ["minute", o],
     ["second", r]
   ];
@@ -201,7 +195,7 @@ function D(t, n = !0) {
     }
   return N.join(", ");
 }
-function C(t, n) {
+function A(t, n) {
   const e = m;
   w(t);
   try {
@@ -210,7 +204,7 @@ function C(t, n) {
     w(e);
   }
 }
-function K(t, n) {
+function C(t, n) {
   const e = y;
   M(t);
   try {
@@ -225,34 +219,32 @@ function w(t) {
 function M(t) {
   y = t;
 }
-function L() {
+function K() {
   return m;
 }
-function Y() {
+function L() {
   return y;
 }
 export {
-  G as clamp,
-  T as currency,
-  Y as defaultCurrency,
-  L as defaultLocale,
-  _ as fileSize,
-  R as forHumans,
+  R as clamp,
+  O as currency,
+  L as defaultCurrency,
+  K as defaultLocale,
+  I as fileSize,
+  T as forHumans,
   g as format,
-  A as minutesToHuman,
-  O as ordinal,
-  H as pairs,
+  k as minutesToHuman,
+  E as ordinal,
+  G as pairs,
   $ as parse,
   x as parseFloat,
   S as parseInt,
-  I as percentage,
+  B as percentage,
   D as secondsToHuman,
-  E as spell,
-  B as spellOrdinal,
   b as summarize,
-  k as trim,
+  H as trim,
   M as useCurrency,
   w as useLocale,
-  K as withCurrency,
-  C as withLocale
+  C as withCurrency,
+  A as withLocale
 };

package/dist/speller/index.d.ts

@@ -0,0 +1,28 @@
+import { ToWords as ToWordsType, ToWords } from 'to-words';
+export declare class Speller {
+    protected toWords: ToWordsType | undefined;
+    protected getToWords(): ToWords;
+    spellNumber(num: number): string;
+}
+/**
+ * Spell out the given number in the given locale.
+ *
+ * @todo
+ *
+ * @requires {@link https://www.npmjs.com/package/to-words to-words package}
+ */
+export declare function spell(_number: number | string, _locale?: string | null, _after?: number | null, _until?: number | null): string;
+/**
+ * Spell out the given number in the given locale in ordinal form.
+ * @todo
+ *
+ * @requires {@link https://www.npmjs.com/package/to-words to-words package}
+ *
+ * @example
+ *
+ * spellOrdinal(1); // "first"
+ * spellOrdinal(2); // "second"
+ * spellOrdinal(3); // "third"
+ */
+export declare function spellOrdinal(_value: number, _locale?: string | null): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/speller/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/speller/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,qBAAa,OAAO;IAChB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;IAE3C,SAAS,CAAC,UAAU,IAAI,OAAO;IAOxB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG1C;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACjB,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,CAMR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CACxB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAAM,GAAG,IAAW,GAC9B,MAAM,CAIR"}

package/dist/speller/index.js

@@ -0,0 +1,21 @@
+import { ToWords as o } from "to-words";
+class s {
+  toWords;
+  getToWords() {
+    return this.toWords || (this.toWords = new o()), this.toWords;
+  }
+  spellNumber(l) {
+    return this.getToWords().convert(l);
+  }
+}
+function u(r, l = null, t = null, e = null) {
+  return "";
+}
+function i(r, l = null) {
+  return "";
+}
+export {
+  s as Speller,
+  u as spell,
+  i as spellOrdinal
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinaid/num",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Utilities for working with numbers similar to Laravel's Num class facade.",
   "type": "module",
   "main": "dist/index.js",
@@ -11,9 +11,17 @@
   "dependencies": {
     "@zinaid/utils": "^0.0.4"
   },
-  "optionalDependencies": {
+  "devDependencies": {
     "to-words": "^4.7.0"
   },
+  "peerDependencies": {
+    "to-words": "^4.7.0"
+  },
+  "peerDependenciesMeta": {
+    "to-words": {
+      "optional": true
+    }
+  },
   "files": [
     "dist"
   ],
@@ -27,13 +35,18 @@
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./*": {
+      "import": "./dist/*",
+      "require": "./dist/*",
+      "types": "./dist/*"
+    },
     "./num": {
       "import": "./dist/num.js",
       "types": "./dist/num.d.ts"
     },
     "./speller": {
-      "import": "./dist/speller.js",
-      "types": "./dist/speller.d.ts"
+      "import": "./dist/speller/index.js",
+      "types": "./dist/speller/index.d.ts"
     }
   }
 }

package/dist/speller.d.ts

@@ -1,7 +0,0 @@
-import { ToWords } from 'to-words';
-export declare class Speller {
-    protected toWords: ToWords | undefined;
-    protected getToWords(): ToWords;
-    spellNumber(num: number): string;
-}
-//# sourceMappingURL=speller.d.ts.map

package/dist/speller.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"speller.d.ts","sourceRoot":"","sources":["../src/speller.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExC,qBAAa,OAAO;IAChB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAEvC,SAAS,CAAC,UAAU,IAAI,OAAO;IAWxB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG1C"}

package/dist/speller.js

@@ -1,20 +0,0 @@
-import { optionalRequire as s } from "@zinaid/utils";
-class e {
-  toWords;
-  getToWords() {
-    if (!this.toWords) {
-      const o = s(
-        "to-words",
-        'The "to-words" package is required for spelling numbers. Please install it: npm install to-words'
-      ).ToWords;
-      this.toWords = new o();
-    }
-    return this.toWords;
-  }
-  spellNumber(o) {
-    return this.getToWords().convert(o);
-  }
-}
-export {
-  e as Speller
-};