# fs-promise-native

> Export promisified fs functions

Latest version **2.0.1** (published 2020-02-07) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2020-02-07 |
| First published | 2017-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 0 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Franklin Davenport |
| Maintainers | sparebytes |
| Keywords | fs, promise, thenable, native, async, await, typescript |

## Links

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

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2020-02-07
- 2.0.0 — 2020-02-07
- 1.0.0 — 2017-12-08
- 0.9.1 — 2017-12-07
- 0.9.0 — 2017-12-07

## README

# fs-promise-native

[![NPM version](https://img.shields.io/npm/v/fs-promise-native.svg?style=flat-square)](https://www.npmjs.com/package/fs-promise-native)
[![BuildStatus](https://img.shields.io/travis/sparebytes/node-fs-promise-native/master.svg?style=flat-square)](https://travis-ci.org/sparebytes/node-fs-promise-native)

`fs-promise-native` is a zero-dependency module that uses node's built-in `util.promisify` to export thenable versions of `fs` functions. Typescript declarations included.

## Installation

[Node.js](http://nodejs.org/) `>= 8` is required. To install, type this at the command line:
```shell
npm install fs-promise-native
```


## Usage

```js
const fspn = require('fs-promise-native');

// thenable
fspn.readFile("./example.txt").then(file => console.log(file));

// async/await
async function example() {
    let file = await fspn.readFile("./example.txt");
    console.log(file);
}

```

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