Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating README.md examples #34

Merged
merged 1 commit into from
Jun 13, 2013
Merged

Updating README.md examples #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
[![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".

## Examples

``` js
filesize(500); // "3.91Kb"
filesize(500); // "3.91 Kb"
filesize(500, true); // "3.9k"
filesize(1500); // "1.46KB"
filesize("1500000000"); // "1.40GB"
filesize("1500000000", 0); // "1GB"
filesize(1212312421412412); // "1.08PB"
filesize(1500); // "1.46 KB"
filesize("1500000000"); // "1.40 GB"
filesize("1500000000", 0); // "1 GB"
filesize(1212312421412412); // "1.08 PB"
filesize(1212312421412412, true); // "1.1P" - shorthand output, similar to *nix "ls -lh"
filesize(265318, 2, false) // "259.10KB" - disabled `bit` sizes with third argument
filesize(265318, 2, false) // "259.10 KB" - disabled `bit` sizes with third argument
```

## How can I load filesize.js?
Expand All @@ -27,4 +28,4 @@ filesize.js is licensed under BSD-3 https://raw.github.com/avoidwork/filesize.js

#### Copyright

Copyright (c) 2013, Jason Mulligan <[email protected]>
Copyright (c) 2013, Jason Mulligan <[email protected]>