@oliversalzburg/js-utils 0.7.0 → 0.8.0

package/lib/format/bytes.d.ts

@@ -0,0 +1,118 @@
+/**
+ * This code was derived from https://github.com/sindresorhus/pretty-bytes/tree/71d686a4cefb314c13b57107de5add5789753900.
+ * It is available under the MIT license.
+ */
+/**
+ * Options for the `formatBytes` function.
+ */
+export interface FormatBytesOptions {
+    /**
+     * Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.
+     */
+    signed?: boolean;
+    /**
+     * - If `false`: Output won't be localized.
+     * - If `true`: Localize the output using the system/browser locale.
+     * - If `string`: Expects a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)
+     * - If `string[]`: Expects a list of [BCP 47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)
+     */
+    locale?: boolean | string | ReadonlyArray<string>;
+    /**
+     * Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).
+     * @example
+     * ```
+     * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+     *
+     * formatBytes(1337, {bits: true});
+     * //=> '1.34 kbit'
+     * ```
+     */
+    bits?: boolean;
+    /**
+     * Format the number using the [Binary Prefix](https://en.wikipedia.org/wiki/Binary_prefix) instead of the [SI Prefix](https://en.wikipedia.org/wiki/SI_prefix). This can be useful for presenting memory amounts. However, this should not be used for presenting file sizes.
+     * @example
+     * ```
+     * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+     *
+     * formatBytes(1000, {binary: true});
+     * //=> '1000 bit'
+     *
+     * formatBytes(1024, {binary: true});
+     * //=> '1 kiB'
+     * ```
+     */
+    binary?: boolean;
+    /**
+     * The minimum number of fraction digits to display.
+     *
+     * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.
+     * @example
+     * ```
+     * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+     *
+     * // Show the number with at least 3 fractional digits
+     * formatBytes(1900, {minimumFractionDigits: 3});
+     * //=> '1.900 kB'
+     *
+     * formatBytes(1900);
+     * //=> '1.9 kB'
+     * ```
+     */
+    minimumFractionDigits?: number;
+    /**
+     * The maximum number of fraction digits to display.
+     *
+     * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.
+     * @example
+     * ```
+     * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+     *
+     * // Show the number with at most 1 fractional digit
+     * formatBytes(1920, {maximumFractionDigits: 1});
+     * //=> '1.9 kB'
+     *
+     * formatBytes(1920);
+     * //=> '1.92 kB'
+     * ```
+     */
+    maximumFractionDigits?: number;
+    /**
+     * Put a space between the number and unit.
+     * @example
+     * ```
+     * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+     *
+     * formatBytes(1920, {space: false});
+     * //=> '1.9kB'
+     *
+     * formatBytes(1920);
+     * //=> '1.92 kB'
+     * ```
+     */
+    space?: boolean;
+}
+/**
+ * Convert bytes to a human readable string: `1337` → `1.34 kB`.
+ * @param number - The number to format.
+ * @param options - The options for formatting the number.
+ * @returns The formatted string.
+ * @example
+ * ```
+ * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+ *
+ * formatBytes(1337);
+ * //=> '1.34 kB'
+ *
+ * formatBytes(100);
+ * //=> '100 B'
+ *
+ * // Display file size differences
+ * formatBytes(42, {signed: true});
+ * //=> '+42 B'
+ *
+ * // Localized output using German locale
+ * formatBytes(1337, {locale: 'de'});
+ * //=> '1,34 kB'
+ * ```
+ */
+export declare const formatBytes: (number: number, options?: Readonly<FormatBytesOptions>) => string;

package/lib/format/bytes.js

@@ -0,0 +1,138 @@
+/**
+ * This code was derived from https://github.com/sindresorhus/pretty-bytes/tree/71d686a4cefb314c13b57107de5add5789753900.
+ * It is available under the MIT license.
+ */
+const BYTE_UNITS = ["B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
+const BIBYTE_UNITS = [
+    "B",
+    "KiB",
+    "MiB",
+    "GiB",
+    "TiB",
+    "PiB",
+    "EiB",
+    "ZiB",
+    "YiB",
+];
+const BIT_UNITS = [
+    "b",
+    "kbit",
+    "Mbit",
+    "Gbit",
+    "Tbit",
+    "Pbit",
+    "Ebit",
+    "Zbit",
+    "Ybit",
+];
+const BIBIT_UNITS = [
+    "b",
+    "kibit",
+    "Mibit",
+    "Gibit",
+    "Tibit",
+    "Pibit",
+    "Eibit",
+    "Zibit",
+    "Yibit",
+];
+/**
+ * Formats the given number using `Number#toLocaleString`.
+ * - If locale is a string, the value is expected to be a locale-key (for example: `de`).
+ * - If locale is true, the system default locale is used for translation.
+ * - If no value for locale is specified, the number is returned unmodified.
+ * @param number - The number to be formatted.
+ * @param locale - The locale to use for formatting.
+ * @param options - Formatting options.
+ * @returns The formatted number.
+ */
+const toLocaleStringInternal = (number, locale, options) => {
+    let result = number;
+    if (typeof locale === "string" || Array.isArray(locale)) {
+        result = number.toLocaleString(locale, options);
+    }
+    else if (locale === true || options !== undefined) {
+        result = number.toLocaleString(undefined, options);
+    }
+    return result.toString();
+};
+/**
+ * Convert bytes to a human readable string: `1337` → `1.34 kB`.
+ * @param number - The number to format.
+ * @param options - The options for formatting the number.
+ * @returns The formatted string.
+ * @example
+ * ```
+ * import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';
+ *
+ * formatBytes(1337);
+ * //=> '1.34 kB'
+ *
+ * formatBytes(100);
+ * //=> '100 B'
+ *
+ * // Display file size differences
+ * formatBytes(42, {signed: true});
+ * //=> '+42 B'
+ *
+ * // Localized output using German locale
+ * formatBytes(1337, {locale: 'de'});
+ * //=> '1,34 kB'
+ * ```
+ */
+export const formatBytes = (number, options = {
+    binary: false,
+    bits: false,
+    space: true,
+}) => {
+    if (!Number.isFinite(number)) {
+        throw new TypeError(`Expected a finite number, got ${typeof number}: ${number.toString()}`);
+    }
+    options = {
+        binary: false,
+        bits: false,
+        space: true,
+        ...options,
+    };
+    const UNITS = options.bits
+        ? options.binary
+            ? BIBIT_UNITS
+            : BIT_UNITS
+        : options.binary
+            ? BIBYTE_UNITS
+            : BYTE_UNITS;
+    const separator = options.space ? " " : "";
+    if (options.signed && number === 0) {
+        return ` 0${separator}${UNITS[0]}`;
+    }
+    const isNegative = number < 0;
+    const prefix = isNegative ? "-" : options.signed ? "+" : "";
+    if (isNegative) {
+        number = -number;
+    }
+    let localeOptions;
+    if (options.minimumFractionDigits !== undefined) {
+        localeOptions = { minimumFractionDigits: options.minimumFractionDigits };
+    }
+    if (options.maximumFractionDigits !== undefined) {
+        localeOptions = {
+            maximumFractionDigits: options.maximumFractionDigits,
+            ...localeOptions,
+        };
+    }
+    if (number < 1) {
+        const numberString = toLocaleStringInternal(number, options.locale, localeOptions);
+        return prefix + numberString + separator + UNITS[0];
+    }
+    const exponent = Math.min(Math.floor(options.binary
+        ? Math.log(number) / Math.log(1024)
+        : Math.log10(number) / 3), UNITS.length - 1);
+    number /= (options.binary ? 1024 : 1000) ** exponent;
+    if (!localeOptions) {
+        number = Number(number.toPrecision(3));
+    }
+    const numberString = toLocaleStringInternal(number, options.locale, localeOptions);
+    const unit = UNITS[exponent];
+    return prefix + numberString + separator + unit;
+};
+//# sourceMappingURL=bytes.js.map

package/lib/format/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../source/format/bytes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkGH,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEzE,MAAM,YAAY,GAAG;IACpB,GAAG;IACH,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;CACL,CAAC;AAEF,MAAM,SAAS,GAAG;IACjB,GAAG;IACH,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACN,CAAC;AAEF,MAAM,WAAW,GAAG;IACnB,GAAG;IACH,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;CACP,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,sBAAsB,GAAG,CAC9B,MAAuB,EACvB,MAA4D,EAC5D,OAA6C,EAC5C,EAAE;IACH,IAAI,MAAM,GAAG,MAAM,CAAC;IACpB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACzD,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACrD,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC1B,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAC1B,MAAc,EACd,OAAO,GAAiC;IACvC,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,KAAK;IACX,KAAK,EAAE,IAAI;CACX,EACA,EAAE;IACH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,SAAS,CAClB,iCAAiC,OAAO,MAAM,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,CACtE,CAAC;IACH,CAAC;IAED,OAAO,GAAG;QACT,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,IAAI;QACX,GAAG,OAAO;KACV,CAAC;IAEF,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI;QACzB,CAAC,CAAC,OAAO,CAAC,MAAM;YACf,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,SAAS;QACZ,CAAC,CAAC,OAAO,CAAC,MAAM;YACf,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,UAAU,CAAC;IAEf,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3C,IAAI,OAAO,CAAC,MAAM,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,KAAK,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACpC,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAE5D,IAAI,UAAU,EAAE,CAAC;QAChB,MAAM,GAAG,CAAC,MAAM,CAAC;IAClB,CAAC;IAED,IAAI,aAKQ,CAAC;IAEb,IAAI,OAAO,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;QACjD,aAAa,GAAG,EAAE,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAC1E,CAAC;IAED,IAAI,OAAO,CAAC,qBAAqB,KAAK,SAAS,EAAE,CAAC;QACjD,aAAa,GAAG;YACf,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;YACpD,GAAG,aAAa;SAChB,CAAC;IACH,CAAC;IAED,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAC1C,MAAM,EACN,OAAO,CAAC,MAAM,EACd,aAAa,CACb,CAAC;QACF,OAAO,MAAM,GAAG,YAAY,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CACxB,IAAI,CAAC,KAAK,CACT,OAAO,CAAC,MAAM;QACb,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;QACnC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CACzB,EACD,KAAK,CAAC,MAAM,GAAG,CAAC,CAChB,CAAC;IACF,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC;IAErD,IAAI,CAAC,aAAa,EAAE,CAAC;QACpB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,YAAY,GAAG,sBAAsB,CAC1C,MAAM,EACN,OAAO,CAAC,MAAM,EACd,aAAa,CACb,CAAC;IAEF,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE7B,OAAO,MAAM,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;AACjD,CAAC,CAAC"}

package/lib/format/bytes.test.d.ts

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

package/lib/format/bytes.test.js

@@ -0,0 +1,146 @@
+import assert from "node:assert";
+import { it } from "node:test";
+import { formatBytes } from "./bytes.js";
+it("throws on invalid input", () => {
+    assert.throws(() => {
+        formatBytes("");
+    });
+    assert.throws(() => {
+        formatBytes("1");
+    });
+    assert.throws(() => {
+        formatBytes(Number.NaN);
+    });
+    assert.throws(() => {
+        formatBytes(true);
+    });
+    assert.throws(() => {
+        formatBytes(Number.POSITIVE_INFINITY);
+    });
+    assert.throws(() => {
+        formatBytes(Number.NEGATIVE_INFINITY);
+    });
+    assert.throws(() => {
+        formatBytes(null);
+    });
+});
+it("converts bytes to human readable strings", () => {
+    assert.strictEqual(formatBytes(0), "0 B");
+    assert.strictEqual(formatBytes(0.4), "0.4 B");
+    assert.strictEqual(formatBytes(0.7), "0.7 B");
+    assert.strictEqual(formatBytes(10), "10 B");
+    assert.strictEqual(formatBytes(10.1), "10.1 B");
+    assert.strictEqual(formatBytes(999), "999 B");
+    assert.strictEqual(formatBytes(1001), "1 kB");
+    assert.strictEqual(formatBytes(1e16), "10 PB");
+    assert.strictEqual(formatBytes(1e30), "1000000 YB");
+});
+it("supports negative number", () => {
+    assert.strictEqual(formatBytes(-0.4), "-0.4 B");
+    assert.strictEqual(formatBytes(-0.7), "-0.7 B");
+    assert.strictEqual(formatBytes(-10.1), "-10.1 B");
+    assert.strictEqual(formatBytes(-999), "-999 B");
+    assert.strictEqual(formatBytes(-1001), "-1 kB");
+});
+it("locale option", () => {
+    assert.strictEqual(formatBytes(-0.4, { locale: "de" }), "-0,4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: "de" }), "0,4 B");
+    assert.strictEqual(formatBytes(1001, { locale: "de" }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: "de" }), "10,1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: "de" }), "1.000.000 YB");
+    assert.strictEqual(formatBytes(-0.4, { locale: "en" }), "-0.4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: "en" }), "0.4 B");
+    assert.strictEqual(formatBytes(1001, { locale: "en" }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: "en" }), "10.1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: "en" }), "1,000,000 YB");
+    assert.strictEqual(formatBytes(-0.4, { locale: ["unknown", "de", "en"] }), "-0,4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: ["unknown", "de", "en"] }), "0,4 B");
+    assert.strictEqual(formatBytes(1001, { locale: ["unknown", "de", "en"] }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: ["unknown", "de", "en"] }), "10,1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: ["unknown", "de", "en"] }), "1.000.000 YB");
+    assert.strictEqual(formatBytes(-0.4, { locale: true }), "-0.4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: true }), "0.4 B");
+    assert.strictEqual(formatBytes(1001, { locale: true }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: true }), "10.1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: true }), "1,000,000 YB");
+    assert.strictEqual(formatBytes(-0.4, { locale: false }), "-0.4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: false }), "0.4 B");
+    assert.strictEqual(formatBytes(1001, { locale: false }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: false }), "10.1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: false }), "1000000 YB");
+    assert.strictEqual(formatBytes(-0.4, { locale: undefined }), "-0.4 B");
+    assert.strictEqual(formatBytes(0.4, { locale: undefined }), "0.4 B");
+    assert.strictEqual(formatBytes(1001, { locale: undefined }), "1 kB");
+    assert.strictEqual(formatBytes(10.1, { locale: undefined }), "10.1 B");
+    assert.strictEqual(formatBytes(1e30, { locale: undefined }), "1000000 YB");
+});
+it("signed option", () => {
+    assert.strictEqual(formatBytes(42, { signed: true }), "+42 B");
+    assert.strictEqual(formatBytes(-13, { signed: true }), "-13 B");
+    assert.strictEqual(formatBytes(0, { signed: true }), " 0 B");
+});
+it("bits option", () => {
+    assert.strictEqual(formatBytes(0, { bits: true }), "0 b");
+    assert.strictEqual(formatBytes(0.4, { bits: true }), "0.4 b");
+    assert.strictEqual(formatBytes(0.7, { bits: true }), "0.7 b");
+    assert.strictEqual(formatBytes(10, { bits: true }), "10 b");
+    assert.strictEqual(formatBytes(10.1, { bits: true }), "10.1 b");
+    assert.strictEqual(formatBytes(999, { bits: true }), "999 b");
+    assert.strictEqual(formatBytes(1001, { bits: true }), "1 kbit");
+    assert.strictEqual(formatBytes(1001, { bits: true }), "1 kbit");
+    assert.strictEqual(formatBytes(1e16, { bits: true }), "10 Pbit");
+    assert.strictEqual(formatBytes(1e30, { bits: true }), "1000000 Ybit");
+});
+it("binary option", () => {
+    assert.strictEqual(formatBytes(0, { binary: true }), "0 B");
+    assert.strictEqual(formatBytes(4, { binary: true }), "4 B");
+    assert.strictEqual(formatBytes(10, { binary: true }), "10 B");
+    assert.strictEqual(formatBytes(10.1, { binary: true }), "10.1 B");
+    assert.strictEqual(formatBytes(999, { binary: true }), "999 B");
+    assert.strictEqual(formatBytes(1025, { binary: true }), "1 KiB");
+    assert.strictEqual(formatBytes(1001, { binary: true }), "1000 B");
+    assert.strictEqual(formatBytes(1e16, { binary: true }), "8.88 PiB");
+    assert.strictEqual(formatBytes(1e30, { binary: true }), "827000 YiB");
+});
+it("bits and binary option", () => {
+    assert.strictEqual(formatBytes(0, { binary: true, bits: true }), "0 b");
+    assert.strictEqual(formatBytes(4, { binary: true, bits: true }), "4 b");
+    assert.strictEqual(formatBytes(10, { binary: true, bits: true }), "10 b");
+    assert.strictEqual(formatBytes(999, { binary: true, bits: true }), "999 b");
+    assert.strictEqual(formatBytes(1025, { binary: true, bits: true }), "1 kibit");
+    assert.strictEqual(formatBytes(1e6, { binary: true, bits: true }), "977 kibit");
+});
+it("fractional digits options", () => {
+    assert.strictEqual(formatBytes(1900, { maximumFractionDigits: 1 }), "1.9 kB");
+    assert.strictEqual(formatBytes(1900, { minimumFractionDigits: 3 }), "1.900 kB");
+    assert.strictEqual(formatBytes(1911, { maximumFractionDigits: 1 }), "1.9 kB");
+    assert.strictEqual(formatBytes(1111, { maximumFractionDigits: 2 }), "1.11 kB");
+    assert.strictEqual(formatBytes(1019, { maximumFractionDigits: 3 }), "1.019 kB");
+    assert.strictEqual(formatBytes(1001, { maximumFractionDigits: 3 }), "1.001 kB");
+    assert.strictEqual(formatBytes(1000, { maximumFractionDigits: 3, minimumFractionDigits: 1 }), "1.0 kB");
+    assert.strictEqual(formatBytes(3942, { maximumFractionDigits: 2, minimumFractionDigits: 1 }), "3.94 kB");
+    assert.strictEqual(formatBytes(4001, { binary: true, maximumFractionDigits: 3 }), "3.907 KiB");
+    assert.strictEqual(formatBytes(18_717, { binary: true, maximumFractionDigits: 2 }), "18.28 KiB");
+    assert.strictEqual(formatBytes(18_717, { binary: true, maximumFractionDigits: 4 }), "18.2783 KiB");
+    assert.strictEqual(formatBytes(32_768, {
+        binary: true,
+        maximumFractionDigits: 3,
+        minimumFractionDigits: 2,
+    }), "32.00 KiB");
+    assert.strictEqual(formatBytes(65_536, {
+        binary: true,
+        maximumFractionDigits: 3,
+        minimumFractionDigits: 1,
+    }), "64.0 KiB");
+});
+it("space option", () => {
+    assert.strictEqual(formatBytes(0), "0 B");
+    assert.strictEqual(formatBytes(0, { space: false }), "0B");
+    assert.strictEqual(formatBytes(999), "999 B");
+    assert.strictEqual(formatBytes(999, { space: false }), "999B");
+    assert.strictEqual(formatBytes(-13, { signed: true }), "-13 B");
+    assert.strictEqual(formatBytes(-13, { signed: true, space: false }), "-13B");
+    assert.strictEqual(formatBytes(42, { signed: true }), "+42 B");
+    assert.strictEqual(formatBytes(42, { signed: true, space: false }), "+42B");
+});
+//# sourceMappingURL=bytes.test.js.map

package/lib/format/bytes.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.test.js","sourceRoot":"","sources":["../../source/format/bytes.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;IAClC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,EAAuB,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,GAAwB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,IAAyB,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,WAAW,CAAC,IAAyB,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;IACnD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAC9C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACnC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IAClD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;IACxB,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAExE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAExE,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACtD,QAAQ,CACR,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACrD,OAAO,CACP,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACtD,MAAM,CACN,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACtD,QAAQ,CACR,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACtD,cAAc,CACd,CAAC;IAEF,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAExE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IAEvE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACrE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;AAC5E,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;IACxB,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAC9D,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;IACtB,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC5D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IACjE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;AACvE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;IACxB,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IACpE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;AACvE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACjC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACxE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACxE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1E,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAC/C,SAAS,CACT,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAC9C,WAAW,CACX,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACpC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9E,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/C,UAAU,CACV,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9E,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/C,SAAS,CACT,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/C,UAAU,CACV,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/C,UAAU,CACV,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EACzE,QAAQ,CACR,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EACzE,SAAS,CACT,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC7D,WAAW,CACX,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/D,WAAW,CACX,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,EAC/D,aAAa,CACb,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,MAAM,EAAE;QACnB,MAAM,EAAE,IAAI;QACZ,qBAAqB,EAAE,CAAC;QACxB,qBAAqB,EAAE,CAAC;KACxB,CAAC,EACF,WAAW,CACX,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,WAAW,CAAC,MAAM,EAAE;QACnB,MAAM,EAAE,IAAI;QACZ,qBAAqB,EAAE,CAAC;QACxB,qBAAqB,EAAE,CAAC;KACxB,CAAC,EACF,UAAU,CACV,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;IACvB,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC/D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7E,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC,CAAC,CAAC"}

package/lib/format/count.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Convert counts to a human readable string: `1234` → `1.234K`.
+ * @param count - The count to format.
+ * @param locale - The locale to use.
+ * @returns The formatted string.
+ */
+export declare const formatCount: (count: number | bigint, locale?: string) => string;
+/**
+ * Convert counts from a human readable string back to a number: `1.234K` → `1234`.
+ * @param count - The count to parse.
+ * @param locale - The locale to use.
+ * @returns The number represented by the input string.
+ */
+export declare const parseCount: (count: string, locale?: string) => number;

package/lib/format/count.js

@@ -0,0 +1,51 @@
+import { mustExist } from "../data/nil.js";
+/**
+ * Convert counts to a human readable string: `1234` → `1.234K`.
+ * @param count - The count to format.
+ * @param locale - The locale to use.
+ * @returns The formatted string.
+ */
+export const formatCount = (count, locale) => {
+    return new Intl.NumberFormat(locale, {
+        compactDisplay: "short",
+        maximumFractionDigits: 3,
+        notation: "compact",
+    }).format(count);
+};
+/**
+ * Convert counts from a human readable string back to a number: `1.234K` → `1234`.
+ * @param count - The count to parse.
+ * @param locale - The locale to use.
+ * @returns The number represented by the input string.
+ */
+export const parseCount = (count, locale) => {
+    const format = new Intl.NumberFormat(locale, {
+        compactDisplay: "short",
+        maximumFractionDigits: 3,
+        notation: "compact",
+    });
+    const parts = format.formatToParts(-12345.6);
+    const orders = Array.from({ length: 20 }).map((_, i) => format.formatToParts(10 ** i).find((d) => d.type === "compact")?.value ??
+        "");
+    const numerals = Array.from({ length: 10 }).map((_, i) => format.format(i));
+    const index = new Map(numerals.map((d, i) => [d, i]));
+    const minusSign = new RegExp(`[${mustExist(parts.find((d) => d.type === "minusSign")).value}]`);
+    const decimal = new RegExp(`[${mustExist(parts.find((d) => d.type === "decimal")).value}]`);
+    const numeral = new RegExp(`[${numerals.join("")}]`, "g");
+    const order = new RegExp(`(${[...new Set(orders.filter((o) => o !== ""))].join("|")})`, "g");
+    const DIRECTION_MARK = /\u061c|\u200e|\u200f/g;
+    let multiplier = 1;
+    const value = count
+        .trim()
+        .replace(DIRECTION_MARK, "")
+        .replace(decimal, ".")
+        .replace(numeral, (d) => mustExist(index.get(d)).toString())
+        .replace(minusSign, "-")
+        .replace(order, (o) => {
+        multiplier = 10 ** orders.indexOf(o);
+        return "";
+    })
+        .replace(/[ \u00a0]/g, "");
+    return +value * multiplier;
+};
+//# sourceMappingURL=count.js.map

package/lib/format/count.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"count.js","sourceRoot":"","sources":["../../source/format/count.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAC1B,KAAsB,EACtB,MAAe,EACN,EAAE;IACX,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACpC,cAAc,EAAE,OAAO;QACvB,qBAAqB,EAAE,CAAC;QACxB,QAAQ,EAAE,SAAS;KACnB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,MAAe,EAAU,EAAE;IACpE,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QAC5C,cAAc,EAAE,OAAO;QACvB,qBAAqB,EAAE,CAAC;QACxB,QAAQ,EAAE,SAAS;KACnB,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAC5C,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACR,MAAM,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK;QACtE,EAAE,CACH,CAAC;IACF,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,IAAI,MAAM,CAC3B,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,CACjE,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,MAAM,CACzB,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,CAC/D,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAG,IAAI,MAAM,CACvB,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAC7D,GAAG,CACH,CAAC;IAEF,MAAM,cAAc,GAAG,uBAAuB,CAAC;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,MAAM,KAAK,GAAG,KAAK;SACjB,IAAI,EAAE;SACN,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;SAC3B,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;SAC3D,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE;QACrB,UAAU,GAAG,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrC,OAAO,EAAE,CAAC;IACX,CAAC,CAAC;SACD,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAC5B,OAAO,CAAC,KAAK,GAAG,UAAU,CAAC;AAC5B,CAAC,CAAC"}

package/lib/format/count.test.d.ts

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

package/lib/format/count.test.js

@@ -0,0 +1,42 @@
+import assert from "node:assert";
+import { it } from "node:test";
+import { formatCount, parseCount } from "./count.js";
+it("formats counts as expected", () => {
+    assert.strictEqual(formatCount(-1), "-1");
+    assert.strictEqual(formatCount(0), "0");
+    assert.strictEqual(formatCount(1), "1");
+    assert.strictEqual(formatCount(10), "10");
+    assert.strictEqual(formatCount(100), "100");
+    assert.strictEqual(formatCount(1000), "1K");
+    assert.strictEqual(formatCount(1234), "1.234K");
+});
+it("parses counts as expected", () => {
+    const testCount = (count, inputLocale, input) => {
+        const locales = inputLocale
+            ? [inputLocale]
+            : "af,af-ZA,ar,ar-AE,ar-BH,ar-DZ,ar-EG,ar-IQ,ar-JO,ar-KW,ar-LB,ar-LY,ar-MA,ar-OM,ar-QA,ar-SA,ar-SY,ar-TN,ar-YE,az,az-AZ,az-AZ,be,be-BY,bg,bg-BG,bs-BA,ca,ca-ES,cs,cs-CZ,cy,cy-GB,da,da-DK,de,de-AT,de-CH,de-DE,de-LI,de-LU,dv,dv-MV,el,el-GR,en,en-AU,en-BZ,en-CA,en-CB,en-GB,en-IE,en-JM,en-NZ,en-PH,en-TT,en-US,en-ZA,en-ZW,eo,es,es-AR,es-BO,es-CL,es-CO,es-CR,es-DO,es-EC,es-ES,es-ES,es-GT,es-HN,es-MX,es-NI,es-PA,es-PE,es-PR,es-PY,es-SV,es-UY,es-VE,et,et-EE,eu,eu-ES,fa,fa-IR,fi,fi-FI,fo,fo-FO,fr,fr-BE,fr-CA,fr-CH,fr-FR,fr-LU,fr-MC,gl,gl-ES,gu,gu-IN,he,he-IL,hi,hi-IN,hr,hr-BA,hr-HR,hu,hu-HU,hy,hy-AM,id,id-ID,is,is-IS,it,it-CH,it-IT,ja,ja-JP,ka,ka-GE,kk,kk-KZ,kn,kn-IN,ko,ko-KR,kok,kok-IN,ky,ky-KG,lt,lt-LT,lv,lv-LV,mi,mi-NZ,mk,mk-MK,mn,mn-MN,mr,mr-IN,ms,ms-BN,ms-MY,mt,mt-MT,nb,nb-NO,nl,nl-BE,nl-NL,nn-NO,ns,ns-ZA,pa,pa-IN,pl,pl-PL,ps,ps-AR,pt,pt-BR,pt-PT,qu,qu-BO,qu-EC,qu-PE,ro,ro-RO,ru,ru-RU,sa,sa-IN,se,se-FI,se-FI,se-FI,se-NO,se-NO,se-NO,se-SE,se-SE,se-SE,sk,sk-SK,sl,sl-SI,sq,sq-AL,sr-BA,sr-BA,sr-SP,sr-SP,sv,sv-FI,sv-SE,sw,sw-KE,syr,syr-SY,ta,ta-IN,te,te-IN,th,th-TH,tl,tl-PH,tn,tn-ZA,tr,tr-TR,tt,tt-RU,ts,uk,uk-UA,ur,ur-PK,uz,uz-UZ,uz-UZ,vi,vi-VN,xh,xh-ZA,zh,zh-CN,zh-HK,zh-MO,zh-SG,zh-TW,zu,zu-ZA".split(",");
+        locales.forEach((locale) => {
+            const formatted = input ?? formatCount(count, locale);
+            const parsed = parseCount(formatted, locale);
+            if (parsed !== count) {
+                const parts = new Intl.NumberFormat(locale).formatToParts(count);
+                const literal = parts
+                    .filter((p) => p.type !== "literal")
+                    .map((part) => `${part.type}:${part.value
+                    .split("")
+                    .map((char) => `U+${char.charCodeAt(0).toString(16).padStart(4, "0")}`)
+                    .join(", ")}`);
+                assert.strictEqual(parsed, count, `Failed for locale '${locale}': '${literal.join(", ")}'`);
+            }
+        });
+    };
+    testCount(-1, "en-US", "-1");
+    testCount(0, "en-US", "0");
+    testCount(1, "en-US", "1");
+    testCount(10, "en-US", "10");
+    testCount(100, "en-US", "100");
+    testCount(1000, "en-US", "1K");
+    testCount(1234, "en-US", "1.234K");
+    testCount(-1234, "en-US", "-1.234K");
+});
+//# sourceMappingURL=count.test.js.map

package/lib/format/count.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"count.test.js","sourceRoot":"","sources":["../../source/format/count.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAErD,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACrC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACpC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,WAAoB,EAAE,KAAc,EAAE,EAAE;QACzE,MAAM,OAAO,GAAG,WAAW;YAC1B,CAAC,CAAC,CAAC,WAAW,CAAC;YACf,CAAC,CAAC,krCAAkrC,CAAC,KAAK,CACxrC,GAAG,CACH,CAAC;QAEJ,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,MAAM,SAAS,GAAG,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAE7C,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBACtB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACjE,MAAM,OAAO,GAAG,KAAK;qBACnB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC;qBACnC,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CACR,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK;qBACxB,KAAK,CAAC,EAAE,CAAC;qBACT,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CACR,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CACxD;qBACA,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;gBACH,MAAM,CAAC,WAAW,CACjB,MAAM,EACN,KAAK,EACL,sBAAsB,MAAM,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACxD,CAAC;YACH,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC3B,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC3B,SAAS,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/B,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC/B,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnC,SAAS,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AACtC,CAAC,CAAC,CAAC"}