@neutrium/formatter - v1.0.1
    Preparing search index...

    Interface BytesFormatSpec

    Locale-aware SI or IEC byte-size specification.

    import { formatter } from "@neutrium/formatter";

    formatter.format(1536, { kind: "bytes" });
    // "1.5 KiB"

    formatter.format(1_500_000, { kind: "bytes", byteBase: 1000 });
    // "1.5 MB"
    interface BytesFormatSpec {
        byteBase?: 1000 | 1024;
        byteExponent?: number;
        decimalSeparator?: string;
        groupSeparator?: string;
        infinityDisplay?: string;
        kind: "bytes";
        locale?: string;
        maximumFractionDigits?: number;
        maximumSignificantDigits?: number;
        minimumFractionDigits?: number;
        minimumIntegerDigits?: number;
        minimumSignificantDigits?: number;
        nanDisplay?: string;
        negativeDisplay?: NegativeDisplay;
        numberingSystem?: string;
        roundingIncrement?: number;
        roundingMode?: RoundingMode;
        roundingPriority?: RoundingPriority;
        signDisplay?: SignDisplay;
        trailingZeroDisplay?: "auto" | "stripIfInteger";
        useGrouping?: GroupingDisplay;
        zeroDisplay?: string;
    }

    Hierarchy (View Summary)

    Index
    byteBase? byteExponent? decimalSeparator? groupSeparator? infinityDisplay? kind locale? maximumFractionDigits? maximumSignificantDigits? minimumFractionDigits? minimumIntegerDigits? minimumSignificantDigits? nanDisplay? negativeDisplay? numberingSystem? roundingIncrement? roundingMode? roundingPriority? signDisplay? trailingZeroDisplay? useGrouping? zeroDisplay?
    byteBase?: 1000 | 1024

    1024 for IEC units or 1000 for SI units. Defaults to 1024.

    byteExponent?: number

    Fixes one byte magnitude (0 = B, 1 = kB/KiB, ... 8 = YB/YiB).

    decimalSeparator?: string

    Replace the locale-derived decimal part after Intl formatting.

    groupSeparator?: string

    Replace the locale-derived grouping part after Intl formatting.

    infinityDisplay?: string

    Replacement for the localized infinity magnitude.

    kind: "bytes"

    Selects the built-in bytes codec.

    locale?: string

    BCP 47 locale overriding the formatter default for this operation.

    maximumFractionDigits?: number

    Maximum fraction digits, rounding excess digits. Does not require that many digits to be shown.

    maximumSignificantDigits?: number

    Maximum number of significant digits.

    minimumFractionDigits?: number

    Minimum fraction digits, padding with zeros as needed. Set both fraction limits for fixed precision.

    minimumIntegerDigits?: number

    Minimum number of integer digits.

    minimumSignificantDigits?: number

    Minimum number of significant digits.

    nanDisplay?: string

    Replacement for the localized NaN magnitude.

    negativeDisplay?: NegativeDisplay

    Render displayed negative signs as parentheses. Defaults to "sign".

    numberingSystem?: string

    Unicode numbering-system identifier, such as latn or arab.

    roundingIncrement?: number

    Increment at the configured fraction precision. For example, 5 with both fraction limits set to 2 rounds to multiples of 0.05. Intl requires equal fraction limits and rejects incompatible significant-digit options.

    roundingMode?: RoundingMode

    Rounding direction used when precision reduces the value. Defaults to halfExpand.

    roundingPriority?: RoundingPriority

    Chooses the winning precision rule when fraction and significant digits are both configured.

    signDisplay?: SignDisplay

    Controls when a positive or negative sign is displayed.

    trailingZeroDisplay?: "auto" | "stripIfInteger"

    Whether insignificant trailing zeroes are retained.

    useGrouping?: GroupingDisplay

    Localized digit-grouping behavior.

    zeroDisplay?: string

    Whole-output replacement for displayed zero, including rounded and negative zero. Omits signs and affixes. Parsing recognizes it as "0" before ordinary numeric syntax, so choose text that does not collide with a nonzero presentation.

    Settings
    Member Visibility

    On This Page
    Properties