README.md

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 >= 8 is required. To install, type this at the command line:

npm install fs-promise-native

Usage

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);
}