Naturally Processed Meals

    cbytes

    1.0.2 • Public • Published

    Cbytes Logo

    🎁 Utility to analyze a byte to unit chain and vice versa, unit converter ‍🌈, from KB to YB and includes many functions that will allow you to make your project more professional

    NPM Version Package License NPM Downloads Coverage

    🌐 Description

    Under the hood, cbytes uses javascript, but also provides compatibility with a wide range of other libraries, such as: ReactJs, Vuejs, Angular, which allows the easy use of countless third-party add-ons that are available.

    📦 Installation

    To start using cbytes, you must install it with the npm or yarn package manager, as shown in the next section,

    // To install using npm
    npm install cbytes -S
     
    // To install using yarn
    yarn add cbytes

    ▶️ Getting started

    To use the powerful function offered by cbytes is very simple, first we will import the package. Example:

    // If you use nodejs, reajs, vuejs, or angular
    const cbytes = require("cbytes");
     
    // If you use ES6+
    import cbytes from "cbytes";

    Example

    cbytes.sizeToObject(6442450944)
    // return: { unit: 'GB', size: 6, format: '6GB' }
     
    cbytes.objectToFormat({ unit: 'TB', size: 6.5, format: '6.5TB' })
    // Return: '6.5TB'
     
    cbytes.objectToFormat({ unit: 'KB', size: 7, format: '7KB' }, {
        separator: " "
    })
    // Return: '7 KB'
     
     
    cbytes.formatToObject("7KB")
    // Return: { unit: 'KB', size: 7, format: '7KB' }
     
     
    cbytes(6291456)
    // Return: '6MB'
     
    cbytes(1000)
    // Return: '1000B'
     
    cbytes(6.88456654, {
        everyThousand: ' '
    })
    // Return: '6.88 456 654B'
     
    /**
     * Options to convert from bytes to units
     * */
    cbytes(6291456, {
      separator: ' ',
      decimals: 2
    })
    // Return: '6.00 MB'
     
     
    cbytes('6GB')
    // Return: 6442450944
     

    Multiples using the prefixes of the International System

    Unit Bytes Factor
    B 1 20
    KB 1024 210
    MB 1 048 576 220
    GB 1 073 741 824 230
    TB 1 099 511 627 776 240
    PB 1 125 899 906 842 624 250
    EX 1 152 921 504 606 846 976 260
    ZB 1 180 591 620 717 411 303 424 270
    YB 1 208 925 819 614 629 174 706 176 280

    Arguments

    Name Type Description
    value number | string Value in bytes
    options Object Conversion options

    Options

    Property Type Description
    decimals number Maximum number of decimals to include in the output. Default value is all decimals
    everyThousand string Example of values: ' ', ',' and .... Default value to ''.
    separator string Separator to use between number and unit. Default value to ''.

    🎩 Stay in touch

    📜 License

    Cbytes is MIT licensed.

    Install

    npm i cbytes

    DownloadsWeekly Downloads

    6

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    12.8 kB

    Total Files

    12

    Last publish

    Collaborators

    • yonicb