glob-size
Get the total size of a glob of files.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.
Install
Install with npm:
$ npm install --save glob-size
This is similar to the UNIX du
command (try du -sh *
for example), but has a JavaScript API. This can be used in linters or build tools, etc. (this is also similar to doing something like ls -l *
).
CLI usage
$ gs$ gs *$ gs "**" -t$ gs "**" -d node_modules Options: --cwd, -d directory to search from [default: "."] --pattern, -p one or more glob patterns, comma-separated --table, -t Show a text table of files sorted by size --stats, -s log out the entire stats object with all files --help Show help [boolean]
API usage
const size = ;
Params
patterns
{string|array}options
{object}returns
{promise}
Example
// get the size of all files in the cwd
.sync
Synchronously get the size of all files that match the given glob patterns
.
Params
patterns
{String|Array}options
{Object}returns
{Object}
Example
// get the size of all files in the cwdconst stats = size;console;
.stats.top
Returns the top n
files by size, sorted in ascending order. (this method is exposed on the returned stats object)
Params
n
{Number}: The number of files to return.returns
{Array}: Array of the topn
files
Example
;
.stats.tableize
Create a text table from the stats.files
array returned by the main export, or from the .top method. (this method is exposed on the returned stats object)
Params
files
{Array}returns
{String}
Example
// tableize the 3 largest files in "node_modules/**" ; // tableize all files ;
Examples
The following examples assume the code is inside an async
function.
// get the size of all `.js` files in the cwdconsole; // get the size of all `.js` files in "./foo"console; // show the 25 largest files in "node_modules/**"const stats = await ;console; // show the 3 largest files in "node_modules/**"const stats = await ;console; // show the 3 largest files in "node_modules/**"const stats = await ;console; // tableize the 3 largest files in "node_modules/**"const stats = await ;console; // tableize all filesconst stats = await ;console;
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 16, 2018.