@zinaid/num 0.0.7 → 0.0.8

package/dist/index.js

@@ -1,7 +1,6 @@
-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";
+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 i, parse as p, 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 { spell as g, spellOrdinal as F } from "./speller/index.js";
 export {
-  T as Speller,
   a as clamp,
   l as currency,
   o as defaultCurrency,
@@ -11,8 +10,8 @@ export {
   t as format,
   c as minutesToHuman,
   m as ordinal,
-  p as pairs,
-  i as parse,
+  i as pairs,
+  p as parse,
   f as parseFloat,
   d as parseInt,
   y as percentage,

package/dist/speller/index.d.ts

@@ -1,28 +1,48 @@
-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
+ * If `after` is provided and the number is less than or equal to `after`,
+ * the number will be returned as a formatted string instead of spelled out.
+ *
+ * If `until` is provided and the number is greater than or equal to `until`,
+ * the number will be returned as a formatted string instead of spelled out.
+ *
+ * @param number - The number to spell out.
+ * @param locale - The locale to use for spelling. Defaults to "en-US".
+ * @param after - If provided, numbers <= this value will be formatted instead of spelled.
+ * @param until - If provided, numbers >= this value will be formatted instead of spelled.
+ * @returns The number spelled out as words, or formatted as a string.
  *
  * @requires {@link https://www.npmjs.com/package/to-words to-words package}
+ *
+ * @example
+ *
+ * spell(123); // "One Hundred Twenty Three"
+ * spell(123.45); // "One Hundred Twenty Three Point Forty Five"
+ * spell(5, null, 10); // "5" (5 <= 10, so formatted instead of spelled)
+ * spell(11, null, 10); // "Eleven" (11 > 10, so spelled out)
+ * spell(100, null, null, 50); // "100" (100 >= 50, so formatted instead of spelled)
+ * spell(49, null, null, 50); // "Forty Nine" (49 < 50, so spelled out)
  */
-export declare function spell(_number: number | string, _locale?: string | null, _after?: number | null, _until?: number | null): string;
+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
+ *
+ * Note: The to-words package doesn't have native ordinal support, so this
+ * function spells out the cardinal number. True ordinal conversion would
+ * require locale-specific suffix rules (e.g., "first", "second", "third").
+ *
+ * @param value - The number to spell out in ordinal form.
+ * @param locale - The locale to use for spelling. Defaults to "en-US".
+ * @returns The number spelled out as words.
  *
  * @requires {@link https://www.npmjs.com/package/to-words to-words package}
  *
  * @example
  *
- * spellOrdinal(1); // "first"
- * spellOrdinal(2); // "second"
- * spellOrdinal(3); // "third"
+ * spellOrdinal(1); // "One"
+ * spellOrdinal(2); // "Two"
+ * spellOrdinal(21); // "Twenty One"
  */
-export declare function spellOrdinal(_value: number, _locale?: string | null): string;
+export declare function spellOrdinal(value: number, locale?: string | null): string;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/speller/index.ts"],"names":[],"mappings":"AA6EA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,KAAK,CACjB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,KAAK,GAAE,MAAM,GAAG,IAAW,EAC3B,KAAK,GAAE,MAAM,GAAG,IAAW,GAC5B,MAAM,CAwBR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CACxB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM,CAcR"}

package/dist/speller/index.js

@@ -1,21 +1,83 @@
-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);
-  }
+import { format as s } from "@zinaid/num";
+import { ToWords as u } from "to-words";
+const l = /* @__PURE__ */ new Set([
+  "bn-IN",
+  "ee-EE",
+  "en-AE",
+  "en-AU",
+  "en-BD",
+  "en-GB",
+  "en-GH",
+  "en-IE",
+  "en-IN",
+  "en-MM",
+  "en-MA",
+  "en-MU",
+  "en-NG",
+  "en-NP",
+  "en-OM",
+  "en-PH",
+  "en-SA",
+  "en-US",
+  "es-AR",
+  "es-ES",
+  "es-MX",
+  "es-VE",
+  "fa-IR",
+  "fr-BE",
+  "fr-FR",
+  "fr-MA",
+  "fr-SA",
+  "gu-IN",
+  "hi-IN",
+  "kn-IN",
+  "ko-KR",
+  "lv-LV",
+  "mr-IN",
+  "nl-SR",
+  "np-NP",
+  "pt-BR",
+  "tr-TR",
+  "ur-PK",
+  "ar-AE",
+  "ar-MA",
+  "ar-SA"
+]);
+function f(n) {
+  if (l.has(n))
+    return n;
+  const o = (n.split("-")[0] || n).toLowerCase();
+  for (const t of l)
+    if (t.toLowerCase().startsWith(o + "-"))
+      return t;
+  return "en-US";
 }
-function u(r, l = null, t = null, e = null) {
-  return "";
+function S(n, r = null, o = null, t = null) {
+  const e = typeof n == "string" ? parseFloat(n) : n;
+  if (o !== null && e <= o)
+    return s(e, null, null, r) || String(e);
+  if (t !== null && e >= t)
+    return s(e, null, null, r) || String(e);
+  const i = f(r ?? "en-US");
+  return new u({
+    localeCode: i,
+    converterOptions: {
+      currency: !1,
+      ignoreDecimal: !1
+    }
+  }).convert(e);
 }
-function i(r, l = null) {
-  return "";
+function d(n, r = null) {
+  const o = f(r ?? "en-US");
+  return new u({
+    localeCode: o,
+    converterOptions: {
+      currency: !1,
+      ignoreDecimal: !0
+    }
+  }).convert(Math.floor(n));
 }
 export {
-  s as Speller,
-  u as spell,
-  i as spellOrdinal
+  S as spell,
+  d as spellOrdinal
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinaid/num",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Utilities for working with numbers similar to Laravel's Num class facade.",
   "type": "module",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
   "license": "MIT",
   "sideEffects": false,
   "dependencies": {
-    "@zinaid/utils": "^0.0.4"
+    "@zinaid/utils": "^0.0.5"
   },
   "devDependencies": {
     "to-words": "^4.7.0"