mirror of
https://github.com/IrosTheBeggar/mStream.git
synced 2025-10-27 07:31:02 +00:00
84 lines
2.0 KiB
Markdown
84 lines
2.0 KiB
Markdown
# Bytes utility
|
|
|
|
Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var bytes = require('bytes');
|
|
```
|
|
|
|
#### 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 | `number` | Value in bytes |
|
|
| options | `Object` | Conversion options |
|
|
|
|
**Options**
|
|
|
|
| Property | Type | Description |
|
|
|-------------------|--------|-----------------------------------------------------------------------------------------|
|
|
| thousandsSeparator | `string`|`null` | Example of values: `' '`, `','` and `.`... Default value to `' '`. |
|
|
|
|
**Returns**
|
|
|
|
| Name | Type | Description |
|
|
|---------|-------------|-------------------------|
|
|
| results | `string`|`null` | Return null upon error. String value otherwise. |
|
|
|
|
**Example**
|
|
|
|
```js
|
|
bytes(1024);
|
|
// output: '1kB'
|
|
|
|
bytes(1000);
|
|
// output: '1000B'
|
|
|
|
bytes(1000, {thousandsSeparator: ' '});
|
|
// output: '1 000B'
|
|
```
|
|
|
|
#### bytes.parse(string value): number|null
|
|
|
|
Parse the string value into an integer in bytes. If no unit is given, it is assumed the value is in bytes.
|
|
|
|
**Arguments**
|
|
|
|
| Name | Type | Description |
|
|
|---------------|--------|--------------------|
|
|
| value | `string` | String to parse. |
|
|
|
|
**Returns**
|
|
|
|
| Name | Type | Description |
|
|
|---------|-------------|-------------------------|
|
|
| results | `number`|`null` | Return null upon error. Value in bytes otherwise. |
|
|
|
|
**Example**
|
|
|
|
```js
|
|
bytes('1kB');
|
|
// output: 1024
|
|
|
|
bytes('1024');
|
|
// output: 1024
|
|
```
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install bytes --save
|
|
component install visionmedia/bytes.js
|
|
```
|
|
|
|
## License
|
|
|
|
[](https://github.com/visionmedia/bytes.js/blob/master/LICENSE)
|