Wondering what’s next for npm?Check out our public roadmap! »

    @tsmx/human-readable

    1.0.6 • Public • Published

    @tsmx/human-readable

    License: MIT npm (scoped) node-current (scoped) Build Status Coverage Status

    Easily create human-readable strings from byte sizes, e.g. 1723817.24 kB. Supports decimal (MB,GB,..) and binary (MiB, GiB,..) units as well as user-defined conversion from/to other sizes.

    For details about the differences of decimal (SI) and binary (IEC) units please refer to Wikipedia.

    Also check out the full documentation.

    Usage

    const hr = require('@tsmx/human-readable');
    
    hr.fromBytes(17238);
    // '17.24 kB'
    
    hr.fromBytes(17238, { mode: 'IEC' });
    // '16.83 KiB'
    
    hr.fromBytes(17238, { numberOnly: true });
    // '17.24'
    
    hr.fromBytes(17238, { fixedPrecision: 1 });
    // '17.2 kB'
    
    hr.fromBytes(17238, { fullPrecision: true });
    // '17.238 kB'
    
    hr.fromTo(17, 'GBYTE', 'KBYTE');
    // '17000000 kB'
    
    hr.fromTo(17, 'GBYTE', 'KBYTE', { mode: 'IEC' });
    // '17825792 KiB'
    
    hr.availableSizes();
    // [ 'BYTE', 'KBYTE', 'MBYTE', 'GBYTE', 'TBYTE', 'PBYTE' ]

    API

    fromBytes(bytes, options)

    Automatically creates a human-readable string out of a given number of bytes. E.g. 7125571.26 kB

    bytes

    Type: Number

    Amount of bytes.

    options

    Type: Object

    Optional.

    mode

    Type: String Default: none (use decimal mode)

    Can be set to IEC to use binary conversion (factor 1.024) and units (KiB,MiB,...). If not set or to any other value, decimal conversion (factor 1.000) and units (kB, MB,...) are used.

    numberOnly

    Type: Boolean Default: false

    If set to true, conversion only returns the number and omits the unit. Overrides noWhitespace.

    fixedPrecision

    Type: Number

    If set the returned number string is formatted to the given fixed decimal places. If not set, the default behaviour of the conversion is to use a dynamic number of decimal places from zero up to two.

    fullPrecision

    Type: Boolean Default: false

    If set to true, the returned number value will be presented with full available decimal places. Overrides fixedPrecision.

    noWhitespace

    Type: Boolean Default: false

    If set to true, the whitespace between the number and unit string is omitted. E.g. 10MB instead of 10 MB.

    fromTo(value, fromSize, toSize, options)

    Converts a value from a given size unit to a human-readable string of the target size. E.g. converting Gigabytes to Megabytes.

    value

    Type: Number

    The value to be converted.

    fromSize

    Type: String

    The size value has. Must be one out of availableSizes.

    toSize

    Type: String

    The size value should be converted to. Must be one out of availableSizes.

    options

    Type: Object

    See options description under fromBytes.

    availableSizes()

    Returns an array of strings of all available sizes.

    Install

    npm i @tsmx/human-readable

    DownloadsWeekly Downloads

    56

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    18.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar