41 lines
791 B
Markdown
41 lines
791 B
Markdown
# pretty-bytes [](https://travis-ci.org/sindresorhus/pretty-bytes)
|
|
|
|
> Convert bytes to a human readable string: `1337` → `1.34 kB`
|
|
|
|
Useful for displaying file sizes for humans.
|
|
|
|
-
|
|
|
|
*Note that it uses base-10 (e.g. kilobyte).
|
|
[Read about the difference between kilobyte and kibibyte.](http://pacoup.com/2009/05/26/kb-kb-kib-whats-up-with-that/)*
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save pretty-bytes
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const prettyBytes = require('pretty-bytes');
|
|
|
|
prettyBytes(1337);
|
|
//=> '1.34 kB'
|
|
|
|
prettyBytes(100);
|
|
//=> '100 B'
|
|
```
|
|
|
|
|
|
## Related
|
|
|
|
- [pretty-bytes-cli](https://github.com/sindresorhus/pretty-bytes-cli) - CLI for this module
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|