Promisify all Node.js builtin async methods
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
.prettierrc
.travis.yml
LICENSE
README.md
data.js
index.js
package.json
test.js
yarn.lock

README.md

promisify-all Build Status

Promisify all Node.js builtin async methods using util.promisify

Installation

npm install --save promisify-all

Usage

Add the following code to the start of your Node.js project:

const promisifyAll = require('promisify-all')

promisifyAll()

Then you have promisified methods such as fs.readFileAsync and fs.writeFileAsync:

const fs = require('fs')

async function main() {
  try {
    const content = await fs.readFileAsync('/path/to/file', 'utf8')
    console.log('Read file succeed! Content: ', content)

    await fs.writeFileAsync('/path/to/another/file', content)
    console.log('Write file succeed!')
  } catch (err) {
    // Handle errors here
  }
}

main()

Options

suffix

Call promisifyAll as follows to customize suffix. The default suffix is Async.

promisifyAll({
  suffix: 'YourSuffix'
})

Promisified methods list

See here

License

MIT