1.0.2 ā¢ Published 4 years ago
š Description
š¦ Installation
// To install using npm
npm install cbytes -S
// To install using yarn
yarn add cbytes
ā¶ļø Getting started
// If you use nodejs, reajs, vuejs, or angular
const cbytes = require("cbytes");
// If you use ES6+
import cbytes from "cbytes";
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.