Skip to content

Commit

Permalink
Updating example in README
Browse files Browse the repository at this point in the history
  • Loading branch information
avoidwork committed Jul 19, 2013
1 parent 15ff11b commit c148806
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
[![build status](https://secure.travis-ci.org/avoidwork/filesize.js.png)](http://travis-ci.org/avoidwork/filesize.js)
# filesize.js

filesize.js provides a simple way to get a human readable file size string from a number (float or integer) or string. An optional second parameter is the decimal place to round to (default is 2), or _true_ which triggers Unix style output. An optional third parameter lets you disable `bit` sizes, e.g. "Kb".
filesize.js provides a simple way to get a human readable file size string from a number (float or integer) or string. An optional second parameter is the decimal place to round to (default is 2), or _true_ which triggers Unix style output. An optional third parameter lets you disable `bit` sizes, e.g. "kb".

## Examples

```javascript
filesize(500); // "3.91 Kb"
filesize(500, true); // "3.9k"
filesize(1500); // "1.46 KB"
filesize("1500000000"); // "1.40 GB"
filesize("1500000000", 0); // "1 GB"
filesize(1212312421412412); // "1.08 PB"
// 0.10.0 switched to base 10, all previous versions use base 2
filesize(500); // "4.00 Kb"
filesize(500, true); // "4.0k"
filesize(1500); // "1.50 KB"
filesize("1500000000"); // "1.50 GB"
filesize("1500000000", 0); // "2GB"
filesize(1212312421412412); // "1.21 PB PB"
filesize(1212312421412412, true); // "1.1P" - shorthand output, similar to "ls -h"
filesize(265318, 2, false) // "259.10 KB" - disabled `bit` sizes with third argument
filesize(265318, 2, false) // "265.32 kB" - disabled `bit` sizes with third argument
```

## How can I load filesize.js?
Expand Down

0 comments on commit c148806

Please sign in to comment.