stat-size/readme.md

Promise that returns the size of a file or directory.

# stat-size


<a href="https://raw.githubusercontent.com/jaid/stat-size/master/license.txt"><img src="https://img.shields.io/github/license/jaid/stat-size?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor stat-size"/></a>  
<a href="https://actions-badge.atrox.dev/jaid/stat-size/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fstat-size%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/stat-size/commits"><img src="https://img.shields.io/github/commits-since/jaid/stat-size/v1.0.2?style=flat-square&logo=github" alt="Commits since v1.0.2"/></a> <a href="https://github.com/jaid/stat-size/commits"><img src="https://img.shields.io/github/last-commit/jaid/stat-size?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/stat-size/issues"><img src="https://img.shields.io/github/issues/jaid/stat-size?style=flat-square&logo=github" alt="Issues"/></a>  
<a href="https://npmjs.com/package/stat-size"><img src="https://img.shields.io/npm/v/stat-size?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/stat-size/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/stat-size?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/stat-size"><img src="https://img.shields.io/npm/dm/stat-size?style=flat-square&logo=npm" alt="Downloads"/></a>

**Promise that returns the size of a file or directory.**





## Installation

<a href="https://npmjs.com/package/stat-size"><img src="https://img.shields.io/badge/npm-stat--size-C23039?style=flat-square&logo=npm" alt="stat-size on npm"/></a>

```bash
npm install --save stat-size@^1.0.2
```

<a href="https://yarnpkg.com/package/stat-size"><img src="https://img.shields.io/badge/Yarn-stat--size-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="stat-size on Yarn"/></a>

```bash
yarn add stat-size@^1.0.2
```

<a href="https://github.com/jaid/stat-size/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/stat--size-24282e?style=flat-square&logo=github" alt="@jaid/stat-size on GitHub Packages"/></a>  
(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))

```bash
npm install --save @jaid/stat-size@^1.0.2
```



## Example


```javascript
import statSize from "stat-size"

const result = statSize("pikachu_8x8.png")
```

Variable `result` will be:

```javascript
129
```

















## Development



Setting up:
```bash
git clone git@github.com:jaid/stat-size.git
cd stat-size
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```


## License
[MIT License](https://raw.githubusercontent.com/jaid/stat-size/master/license.txt)  
Copyright © 2020, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)