bytes

What is bytes?

The 'bytes' npm package is a utility for parsing and formatting byte sizes. It allows users to easily convert between different units of bytes and parse strings with byte size information into numbers. It is useful for displaying file sizes in a human-readable format or for parsing user input into byte quantities.

What are bytes's main functionalities?

Parse byte size strings

This feature allows you to parse a string representing a byte size into an integer number of bytes. For example, passing '1000KB' will return 1000000.

"1000KB" // returns 1000000

Format bytes into strings

This feature allows you to format an integer number of bytes into a string with a unit. For example, passing 1024 will return '1KB'.

1024 // returns '1KB'

Specify the number of decimal places

This feature allows you to specify the number of decimal places when formatting bytes into a string. For example, passing an object with 1000 bytes and 1 decimal place will return '1.0KB'.

{ bytes: 1000, decimalPlaces: 1 } // returns '1.0KB'

Specify the unit of bytes

This feature allows you to specify the unit when formatting bytes. For example, passing an object with 1024 bytes and 'kB' as the unit will return '1kB'.

{ bytes: 1024, unit: 'kB' } // returns '1kB'

Other packages similar to bytes

filesize

The 'filesize' package provides similar functionality to 'bytes' by allowing users to convert byte amounts into human-readable strings. It offers more options for customization, such as setting the base, standard (SI or IEC), rounding method, and partials.

pretty-bytes

The 'pretty-bytes' package is another alternative to 'bytes' that converts byte values into a human-readable format. It supports negative numbers, localization, and can automatically choose the appropriate unit.

README

node-bytes

Byte string parser / formatter.

Example:

bytes('1kb')
// => 1024

bytes('2mb')
// => 2097152

bytes('1gb')
// => 1073741824

bytes(1073741824)
// => 1gb

bytes(1099511627776)
// => 1tb

Installation

$ npm install bytes
$ component install visionmedia/bytes.js

License

(The MIT License)

Copyright (c) 2012 TJ Holowaychuk <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.