# format-io

> Format size, permissions

Latest version **2.0.0** (published 2019-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install format-io
pnpm add format-io
yarn add format-io
bun add format-io
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-09-20 |
| First published | 2014-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/format-io) |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | format, size, permissions |

## Links

- npm: https://www.npmjs.com/package/format-io
- Repository: https://github.com/coderaiser/format-io
- Homepage: http://github.com/coderaiser/format-io
- Issues: https://github.com/coderaiser/format-io/issues
- npm.io page: https://npm.io/package/format-io

## Dependencies (1)

- [currify](https://npm.io/package/currify.md) ^4.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-09-20
- 1.0.3 — 2018-10-10
- 1.0.2 — 2018-06-14
- 1.0.1 — 2018-06-12
- 1.0.0 — 2018-06-12
- 0.9.6 — 2015-02-18
- 0.9.5 — 2014-09-04
- 0.9.4 — 2014-06-26
- 0.9.2 — 2014-06-26

## README

# Format [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

Format size, permissions, etc.

# How to use?

Format could be used in browser or node.

```js
const format = require('format-io');
```

# API

## size

```js
const size = 1024 * 1024 * 5;
format.size(size);
// returns
'5.00mb'
```

## permissions.symbolic

```js
const perm = '00777';
format.permissions.symbolic(perm);
// returns
'rwx rwx rwx'
```

## permissions.numeric

```js
const perm = 'rwx rwx rwx';
format.permissions.numeric(perm);
// returns
'00777'
```

# License

MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/format-io.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/format-io/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/format-io.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]:                   https://npmjs.org/package/format-io "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/format-io  "Build Status"
[DependencyStatusURL]:      https://david-dm.org/coderaiser/format-io "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"

[CoverageURL]:              https://coveralls.io/github/coderaiser/format-io?branch=master
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/format-io/badge.svg?branch=master&service=github

---
_Source: https://npm.io/package/format-io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._