@zinaid/num 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Abraham Arango
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './num';
+export * from './speller';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC"}

package/dist/index.js

@@ -0,0 +1,28 @@
+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";
+export {
+  F as Speller,
+  a as clamp,
+  l as currency,
+  o as defaultCurrency,
+  n as defaultLocale,
+  s as fileSize,
+  u as forHumans,
+  t as format,
+  c as minutesToHuman,
+  m as ordinal,
+  p as pairs,
+  i as parse,
+  f as parseFloat,
+  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
+};

package/dist/num.d.ts

@@ -0,0 +1,201 @@
+/**
+ * Format the given number according to the current locale.
+ *
+ * @example
+ *
+ * format(1234.5678, 2); // "1,234.57"
+ * format(1234.5678, 2, 4); // "1,234.5678"
+ * format(1234.5678, 2, 4, "de"); // "1.234,5678"
+ */
+export declare function format(number: number, precision?: number | null, maxPrecision?: number | null, locale?: string | null): string | false;
+/**
+ * Parse the given string according to the specified format type.
+ *
+ * @example
+ *
+ * parse("1,234.57"); // 1234.57
+ */
+export declare function parse(value: string, locale?: string | null): number;
+/**
+ * Parse a string into an integer according to the specified locale.
+ *
+ * @example
+ *
+ * parseInt("1,234", "en"); // 1234
+ */
+export declare function parseInt(value: string, locale?: string | null): number | false;
+/**
+ * Parse a string into a float according to the specified locale.
+ *
+ * @param  string  $string
+ * @param  string|null  $locale
+ * @return float|false
+ */
+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.
+ *
+ * @example
+ *
+ * ordinal(1); // "1st"
+ * ordinal(2); // "2nd"
+ * ordinal(3); // "3rd"
+ * 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.
+ *
+ * @example
+ *
+ * percentage(1); // "1%"
+ * percentage(1.75, 2); // "1.75%"
+ * percentage(0.12345, 4); // "0.1235%"
+ */
+export declare function percentage(number: number | string, precision?: number, maxPrecision?: number | null, locale?: string | null): string | false;
+/**
+ * Convert the given number to its currency equivalent.
+ *
+ * @example
+ *
+ * currency(5.00); // "$5.00"
+ * currency(-5); // "-$5.00"
+ * currency(10, 'EUR'); // "€10.00"
+ */
+export declare function currency(amount: number | string, currencyCode?: string, locale?: string | null, precision?: number | null): string | false;
+/**
+ * Convert the given number to its file size equivalent.
+ *
+ * @example
+ *
+ * fileSize(1024); // "1 KB"
+ * fileSize(2048); // "2 KB"
+ * fileSize(1264.12345, 3); // "1.234 KB"
+ */
+export declare function fileSize(bytes: number | string, precision?: number, maxPrecision?: number | null): string;
+/**
+ * Convert the number to its human-readable equivalent.
+ *
+ * @example
+ *
+ * forHumans(1234); // "1.234 thousand"
+ * forHumans(1234567); // "1.234 million"
+ * forHumans(1234567890); // "1.234 billion"
+ */
+export declare function forHumans(value: number, precision?: number, maxPrecision?: number | null, abbreviate?: boolean): string | false;
+/**
+ * Convert the number to its human-readable equivalent.
+ *
+ * @example
+ *
+ * summarize(1234); // "1.234 K"
+ * summarize(1234567); // "1.234 M"
+ * summarize(1234567890); // "1.234 B"
+ */
+export declare function summarize(value: number, precision?: number, maxPrecision?: number | null, units?: Record<number, string>): string | false;
+/**
+ * Clamp the given number between the given minimum and maximum.
+ *
+ * @example
+ *
+ * clamp(5, 1, 10); // 5
+ * clamp(0, 1, 10); // 1
+ * clamp(15, 1, 10); // 10
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Split the given number into pairs of min/max values.
+ *
+ * @example
+ *
+ * pairs(25, 10, 1, 1); // [[1, 11], [11, 21], [21, 25]]
+ */
+export declare function pairs(to: number, by: number, start?: number, offset?: number): [number, number][];
+/**
+ * Remove any trailing zero digits after the decimal point of the given number.
+ *
+ * @example
+ *
+ * trim(12.3456789); // 12.3456789
+ * trim(12.34567890000); // 12.3456789
+ */
+export declare function trim(value: number): number;
+/**
+ * Convert a duration in minutes to a human-readable format.
+ *
+ * @param minutes The duration in minutes.
+ * @param round Whether to round to the nearest unit.
+ * @returns The human-readable duration string.
+ *
+ * @example
+ *
+ * minutesToHuman(61); // "1 hour"
+ * minutesToHuman(61, false); // "1 hour, 1 minute"
+ */
+export declare function minutesToHuman(minutes: number | string, round?: boolean): string;
+/**
+ * Convert a duration in seconds to a human-readable format.
+ *
+ * @param seconds The duration in seconds.
+ * @param round Whether to round to the nearest unit.
+ * @returns The human-readable duration string.
+ *
+ * @example
+ *
+ * secondsToHuman(3661); // "1 hour"
+ * secondsToHuman(3661, false); // "1 hour, 1 minute, 1 second"
+ */
+export declare function secondsToHuman(seconds: number | string, round?: boolean): string;
+/**
+ * Execute the given callback using the given locale.
+ *
+ * @example
+ *
+ * withLocale("fr", () => {
+ *     return format(1234.56);
+ * }); // "1 234,56"
+ */
+export declare function withLocale(locale: string, callback: () => unknown): unknown;
+/**
+ * Execute the given callback using the given currency.
+ *
+ * @example
+ *
+ * withCurrency("EUR", () => {
+ *     return format(1234.56);
+ * }); // "€1,234.56"
+ */
+export declare function withCurrency(currency: string, callback: () => unknown): unknown;
+/**
+ * Set the default locale.
+ */
+export declare function useLocale(locale: string): void;
+/**
+ * Set the default currency.
+ */
+export declare function useCurrency(currency: string): void;
+/**
+ * Get the default locale.
+ */
+export declare function defaultLocale(): string;
+/**
+ * Get the default currency.
+ */
+export declare function defaultCurrency(): string;
+//# sourceMappingURL=num.d.ts.map

package/dist/num.d.ts.map

@@ -0,0 +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"}

package/dist/num.js

@@ -0,0 +1,258 @@
+let m = "en", y = "USD";
+function g(t, n = null, e = null, r = null) {
+  r = r ?? m;
+  const o = {
+    style: "decimal",
+    useGrouping: !0
+  };
+  return e != null ? (o.maximumFractionDigits = e, o.minimumFractionDigits = 0) : n != null && (o.minimumFractionDigits = n, o.maximumFractionDigits = n), new Intl.NumberFormat(r, o).format(t);
+}
+function $(t, n = null) {
+  n = n ?? m;
+  const r = new Intl.NumberFormat(n).formatToParts(12345.6), o = /* @__PURE__ */ new Set();
+  let s = ".";
+  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;
+  for (const i of o) {
+    const c = new RegExp(
+      i.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"),
+      "g"
+    );
+    l = l.replace(c, "");
+  }
+  if (s !== ".") {
+    const i = new RegExp(
+      s.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"),
+      "g"
+    ), c = l.lastIndexOf(s);
+    c !== -1 && (l = l.slice(0, c).replace(i, "") + "." + l.slice(c + s.length));
+  }
+  return l = l.replace(/[\s\u00A0\u202F\u2009]+/g, "").trim(), globalThis.Number(l);
+}
+function S(t, n = null) {
+  const e = $(t, n);
+  return Number.isNaN(e) ? !1 : e < 0 ? Math.ceil(e) : Math.floor(e);
+}
+function x(t, n = null) {
+  return $(t, n);
+}
+function E(t, n = null, e = null, r = null) {
+  return "";
+}
+function O(t, n = null) {
+  const e = n ?? m;
+  try {
+    const o = new Intl.PluralRules(e, { type: "ordinal" }).select(t), s = e.split("-")[0] || "en", u = {
+      en: { one: "st", two: "nd", few: "rd", other: "th" }
+    }, l = u[s] ?? u.en, p = l[o] ?? l.other;
+    return `${t}${p}`;
+  } catch {
+    const r = Math.abs(t), o = r % 100;
+    if (o >= 11 && o <= 13)
+      return `${t}th`;
+    switch (r % 10) {
+      case 1:
+        return `${t}st`;
+      case 2:
+        return `${t}nd`;
+      case 3:
+        return `${t}rd`;
+      default:
+        return `${t}th`;
+    }
+  }
+}
+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 = {
+    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);
+}
+function T(t, n = "", e = null, r = null) {
+  const o = e ?? m, s = typeof t == "string" ? $(t, o) : t, l = {
+    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);
+}
+function _(t, n = 0, e = null) {
+  let r = typeof t == "string" ? Number(t) : t;
+  Number.isFinite(r) || (r = 0);
+  const o = [
+    "B",
+    "KB",
+    "MB",
+    "GB",
+    "TB",
+    "PB",
+    "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]}`;
+}
+function R(t, n = 0, e = null, r = !1) {
+  return b(
+    t,
+    n,
+    e,
+    r ? {} : {
+      3: " thousand",
+      6: " million",
+      9: " billion",
+      12: " trillion",
+      15: " quadrillion"
+    }
+  );
+}
+function b(t, n = 0, e = null, r = {}) {
+  if (Object.keys(r).length === 0 && (r = {
+    3: "K",
+    6: "M",
+    9: "B",
+    12: "T",
+    15: "Q"
+  }), Number(t) === 0)
+    return n > 0 ? g(0, n, e) : "0";
+  if (t < 0)
+    return `-${b(
+      Math.abs(t),
+      n,
+      e,
+      r
+    )}`;
+  if (t >= 1e15) {
+    const i = Object.keys(r).map((a) => Number(a)).filter((a) => !Number.isNaN(a)).sort((a, f) => a - f), c = i[i.length - 1], h = r[c];
+    return `${b(
+      t / 1e15,
+      n,
+      e,
+      r
+    )}${h}`.trim();
+  }
+  const o = Math.floor(Math.log10(t)), s = o - o % 3, u = t / Math.pow(10, s);
+  let l;
+  if (e != null)
+    l = g(u, null, e);
+  else if (n > 0)
+    l = g(u, n, null);
+  else {
+    const i = Math.abs(t);
+    l = s === 3 && u < 10 && i % 10 === 0 ? g(u, null, 1) : g(u, 0, null);
+  }
+  const p = r[s] ?? "";
+  return `${l}${p}`.trim();
+}
+function G(t, n, e) {
+  return Math.min(Math.max(t, n), e);
+}
+function H(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]);
+  }
+  return o;
+}
+function k(t) {
+  return JSON.parse(JSON.stringify(t));
+}
+function A(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 = [
+    ["year", 12 * p],
+    ["month", p],
+    ["week", l],
+    ["day", u],
+    ["hour", s],
+    ["minute", o],
+    ["second", r]
+  ];
+  if (n)
+    for (const [a, f] of c) {
+      const d = e / f;
+      if (d >= 0.5 || f === r) {
+        const F = Math.round(d);
+        return `${F} ${a}${F === 1 ? "" : "s"}`;
+      }
+    }
+  let h = e;
+  const N = [];
+  for (const [a, f] of c)
+    if (h >= f) {
+      const d = Math.floor(h / f);
+      h -= d * f, N.push(`${d} ${a}${d === 1 ? "" : "s"}`);
+    }
+  return N.join(", ");
+}
+function C(t, n) {
+  const e = m;
+  w(t);
+  try {
+    return n();
+  } finally {
+    w(e);
+  }
+}
+function K(t, n) {
+  const e = y;
+  M(t);
+  try {
+    return n();
+  } finally {
+    M(e);
+  }
+}
+function w(t) {
+  m = t;
+}
+function M(t) {
+  y = t;
+}
+function L() {
+  return m;
+}
+function Y() {
+  return y;
+}
+export {
+  G as clamp,
+  T as currency,
+  Y as defaultCurrency,
+  L as defaultLocale,
+  _ as fileSize,
+  R as forHumans,
+  g as format,
+  A as minutesToHuman,
+  O as ordinal,
+  H as pairs,
+  $ as parse,
+  x as parseFloat,
+  S as parseInt,
+  I as percentage,
+  D as secondsToHuman,
+  E as spell,
+  B as spellOrdinal,
+  b as summarize,
+  k as trim,
+  M as useCurrency,
+  w as useLocale,
+  K as withCurrency,
+  C as withLocale
+};

package/dist/speller.d.ts

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

package/dist/speller.d.ts.map

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