# promise-fs

> Wraps FS methods using Promise

Latest version **2.1.1** (published 2019-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install promise-fs
pnpm add promise-fs
yarn add promise-fs
bun add promise-fs
```

## Health

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

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2019-07-03 |
| First published | 2015-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/promise-fs) |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 2.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Nick K. |
| Maintainers | octetstream |
| Keywords | promise, promisify, fs |

## Links

- npm: https://www.npmjs.com/package/promise-fs
- Repository: https://github.com/octet-stream/promise-fs
- Homepage: https://github.com/octet-stream/promise-fs#readme
- Issues: https://github.com/octet-stream/promise-fs/issues
- npm.io page: https://npm.io/package/promise-fs

## Dependencies (1)

- [@octetstream/promisify](https://npm.io/package/@octetstream/promisify.md) 2.0.2

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.1.1 (latest) — 2019-07-03
- 2.1.0 — 2019-03-16
- 2.0.1 — 2018-10-08
- 2.0.0 — 2018-10-05
- 1.3.0 — 2017-09-19
- 1.2.3 — 2016-10-26
- 1.2.2 — 2016-10-26
- 1.2.1 — 2016-10-26
- 1.2.0 — 2016-10-26
- 1.1.0 — 2016-08-20
- 1.0.0 — 2016-06-17
- 0.2.2 — 2015-09-07
- 0.1.2 — 2015-07-05

## README

# Promise FS

Wraps FS methods using Promise

## Installation

You can install this module using Yarn:

```
yarn add promise-fs
```

```
npm install promise-fs
```

## Usage

```js
  import fs from "promise-fs"

  fs.readFile("path/to/file")
    .then(content => console.log(String(content))) // Do something with the content
    .catch(err => console.log(err)) // Handle error
```

# Wrapped methods:

access, readFile, writeFile, close, open, read, write, rename, rmdir, mkdir, readdir, stat, lstat, fstat, appendFile, realpath, link, unlink, readlink, chmod, fchmod, chown, fchown, lchown, fsync, utimes, futimes, ftruncate

# License

MIT

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