www.aleph1.co.uk Git - yaffs-website/blob - node_modules/pretty-bytes/readme.md

   1 # pretty-bytes [![Build Status](https://travis-ci.org/sindresorhus/pretty-bytes.svg?branch=master)](https://travis-ci.org/sindresorhus/pretty-bytes)
   2
   3 > Convert bytes to a human readable string: `1337` → `1.34 kB`
   4
   5 Useful for displaying file sizes for humans.
   6
   7 -
   8
   9 *Note that it uses base-10 (eg. kilobyte).
  10 [Read about the difference between kilobyte and kibibyte.](http://pacoup.com/2009/05/26/kb-kb-kib-whats-up-with-that/)*
  11
  12
  13 ## Install
  14
  15 ```
  16 $ npm install --save pretty-bytes
  17 ```
  18
  19
  20 ## Usage
  21
  22 ```js
  23 const prettyBytes = require('pretty-bytes');
  24
  25 prettyBytes(1337);
  26 //=> '1.34 kB'
  27
  28 prettyBytes(100);
  29 //=> '100 B'
  30 ```
  31
  32
  33 ## Related
  34
  35 - [pretty-bytes-cli](https://github.com/sindresorhus/pretty-bytes-cli) - CLI for this module
  36
  37
  38 ## License
  39
  40 MIT © [Sindre Sorhus](http://sindresorhus.com)