# pifs

> Promisified graceful-fs

Latest version **2.0.0** (published 2020-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install pifs
pnpm add pifs
yarn add pifs
bun add pifs
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-08-14 |
| First published | 2019-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.13.0 |
| Dependencies | 2 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | deepsweet, fosimus, psxcode |
| Keywords | fs, graceful-fs, promise, promisify |

## Links

- npm: https://www.npmjs.com/package/pifs
- Repository: https://github.com/nextools/metarepo
- Homepage: https://github.com/nextools/metarepo#readme
- Issues: https://github.com/nextools/metarepo/issues
- npm.io page: https://npm.io/package/pifs

## Dependencies (2)

- [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.2.0
- [@types/graceful-fs](https://npm.io/package/@types/graceful-fs.md) ^4.1.3

## 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.0.0 (latest) — 2020-08-14
- 1.0.3 — 2020-07-31
- 1.0.2 — 2020-03-06
- 1.0.1 — 2020-02-27
- 1.0.0 — 2020-01-23
- 0.1.1 — 2019-09-20
- 0.1.0 — 2019-07-05
- 0.0.0 — 2019-07-05

## README

# pifs ![npm](https://flat.badgen.net/npm/v/pifs)

Promisified [graceful-fs](https://github.com/isaacs/node-graceful-fs).

* aligned with Node.js v10
* native `util.promisify()`
* no sync methods
* no deprecated methods like `exists`
* no undocumented exports like `FileReadStream` or `F_OK`
* no `promises` :)
* non-callback methods like `createReadStream` or `watch` are re-exported as is
* `constants` is re-exported as is

## Install

```sh
$ yarn add pifs
```

## Usage

```js
import { readFile } from 'pifs'

readFile('/file/path', 'utf8')
  .then(console.log)
  .catch(console.error)
```

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