Bytes utility
Utility to parse a string bytes (ex: 1TB
) to bytes (1099511627776
) and vice-versa.
Installation
This is a Node.js module available through the npm registry. Installation is done using the npm install
command:
Usage
bytes.format(number value, [options]): string|null
Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is rounded.
Arguments
Name | Type | Description |
---|---|---|
value |
| Value in bytes |
options |
| Conversion options |
Options
Property | Type | Description |
---|---|---|
decimalPlaces |
| Maximum number of decimal places to include in output. Default value to |
fixedDecimals |
| Whether to always display the maximum number of decimal places. Default value to |
thousandsSeparator |
| Example of values: |
unit |
| The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to |
unitSeparator |
| Separator to use between number and unit. Default value to |
Returns
Name | Type | Description |
---|---|---|
results |
| Return null upon error. String value otherwise. |
Example
bytes.parse(string|number value): number|null
Parse the string value into an integer in bytes. If no unit is given, or value
is a number, it is assumed the value is in bytes.
Supported units and abbreviations are as follows and are case-insensitive:
b
for byteskb
for kilobytesmb
for megabytesgb
for gigabytestb
for terabytes
The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.
Arguments
Name | Type | Description |
---|---|---|
value |
| String to parse, or number in bytes. |
Returns
Name | Type | Description |
---|---|---|
results |
| Return null upon error. Value in bytes otherwise. |
Example
License
Last updated