https://github.com/coderaiser/trammel
Get directory size for node
https://github.com/coderaiser/trammel
cloudcmd javascript nodejs size
Last synced: about 2 months ago
JSON representation
Get directory size for node
- Host: GitHub
- URL: https://github.com/coderaiser/trammel
- Owner: coderaiser
- License: mit
- Created: 2014-06-25T13:02:55.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T15:36:37.000Z (about 2 years ago)
- Last Synced: 2025-10-29T21:47:47.840Z (5 months ago)
- Topics: cloudcmd, javascript, nodejs, size
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Trammel [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]
[NPMIMGURL]: https://img.shields.io/npm/v/trammel.svg?style=flat
[BuildStatusURL]: https://github.com/coderaiser/trammel/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/trammel/workflows/Node%20CI/badge.svg
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/trammel "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
Get directory size.
If you want get realtime size updates use [dirsize](https://github.com/coderaiser/node-dirsize).
## Example
```js
import trammel from 'trammel';
await trammel('.');
// returns
'58.47kb';
await trammel('.', {
type: 'raw',
});
// returns
59_974;
await trammel('do not exist', {
stopOnError: true,
});
// throws
Error;
```
## License
MIT