tree: 56bc75fcf2914e3391e8f21570949c559b945a06 [path history] [tgz]
  1. History.md
  2. index.js
  3. LICENSE
  4. package.json
  5. Readme.md
node_modules/cordova-serve/node_modules/compression/node_modules/bytes/Readme.md

Bytes utility

NPM Version NPM Downloads Build Status

Utility to parse a string bytes (ex: 1TB) to bytes (1099511627776) and vice-versa.

Usage

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

NameTypeDescription
valuenumberValue in bytes
optionsObjectConversion options

Options

PropertyTypeDescription
decimalPlacesnumber|nullMaximum number of decimal places to include in output. Default value to 2.
fixedDecimalsboolean|nullWhether to always display the maximum number of decimal places. Default value to false
thousandsSeparatorstring|nullExample of values: ' ', ',' and .... Default value to ' '.

Returns

NameTypeDescription
resultsstring|nullReturn null upon error. String value otherwise.

Example

bytes(1024);
// output: '1kB'

bytes(1000);
// output: '1000B'

bytes(1000, {thousandsSeparator: ' '});
// output: '1 000B'

bytes(1024 * 1.7, {decimalPlaces: 0});
// output: '2kB'

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

NameTypeDescription
valuestringString to parse.

Returns

NameTypeDescription
resultsnumber|nullReturn null upon error. Value in bytes otherwise.

Example

bytes('1kB');
// output: 1024

bytes('1024');
// output: 1024

Installation

npm install bytes --save
component install visionmedia/bytes.js

License

npm