Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Nijikokun/file-size
📂 Lightweight filesize to human-readable / proportions w/o dependencies for node.js & browsers.
https://github.com/Nijikokun/file-size
Last synced: about 2 months ago
JSON representation
📂 Lightweight filesize to human-readable / proportions w/o dependencies for node.js & browsers.
- Host: GitHub
- URL: https://github.com/Nijikokun/file-size
- Owner: nijikokun
- License: mit
- Created: 2013-12-09T08:36:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-22T19:06:22.000Z (over 4 years ago)
- Last Synced: 2024-01-31T10:55:23.642Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 230
- Watchers: 9
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Lists
- awesome-micro-npm-packages - file-size - Lightweight filesize to human-readable / proportions w/o dependencies. (Modules / File System)
- awesome-micro-npm-packages - file-size - Lightweight filesize to human-readable / proportions w/o dependencies. (Modules / File System)
README
# file-size
File-size module for node.js for converting, manipulating, and handling file-sizes.
## Features
- Zero Dependencies.
- Supports IEC (power `1024`, _default_), SI (power `1000`), and JEDEC (Alternative SI Unit Notation).
- Conversion from `bytes` to `K`, `M`, `G`, and so forth...
- Customizable human-readable output.
## Installation
```bash
$ npm install file-size
```
Now require it in your files like so:
```javascript
var filesize = require('file-size');
```
## Usage
```javascript
filesize(Number bytes, Object options)
```
Using filesize is very easy, a lot easier if you know the [Specification Table](http://en.wikipedia.org/wiki/Template:Quantities_of_bytes). However,
it's not required to know it, and in most cases you won't need it.
**Initialization**
Filesize works in a jQuery chainable manner so you can use multiple instances without trouble.
```javascript
var size = filesize(186457865);
```
**Options**
```javascript
var size = filesize(186457865, {
fixed: 2,
spacer: ' '
});
```
- `fixed` - Number of positions after the decimal to show, default is `2`
- `spacer` - Space between the number and the unit, default is a space ` `
### size.human(String spec) -> String
Generates human readable filesize.
- `spec` can be one of the following:
- `si`
- `iec`
- `jedec`
##### IEC Specification
*Default*
Power of `1024`
```javascript
// outputs: 177.82 MiB
filesize(186457865).human();
```
##### SI Specification
Power of `1000`
```javascript
// outputs: 186.46 MB
filesize(186457865).human('si');
```
##### JEDEC Specification
Changes IEC default unit notation `iB` to `B` for the following: `KB`, `MB`, `GB`
The rest are in `iB` notation, as per JEDEC Specification.
```javascript
// outputs: 186.46 MB
filesize(186457865).human('jedec');
```
### size.to(String unit, String spec) -> String
Converts `bytes` to another filesize `unit`
- `unit` of size can be one of the following:
- `B`, `KB`, `MB`, `GB`, `TB`, `PB`, `EB`, `ZB`, `YB`
- `spec` can be one of the following:
- `si`
- `iec`
- `jedec`
##### IEC Specification
*Default*
```javascript
// outputs: 177.82
filesize(186457865).to('MB');
```
##### SI Specification
```javascript
// outputs: 186.46
filesize(186457865).to('MB', 'si');
```
### size.calculate(String spec) -> Object
Calculates suffix, magnitude, fixed, non-fixed, bits (fixed, non-fixed) from specified bytes against the specified `spec`.
- `spec` can be one of the following:
- `si`
- `iec`
- `jedec`
```js
/*
* outputs:
*
* {
* suffix: 'Bytes',
* magnitude: 0,
* result: 8,
* fixed: '8.00',
* bits: { result: 1, fixed: '1.00' }
* }
*/
var result = filesize(8).calculate()
```