https://github.com/mikehall314/es6-promisify

Convert callback-based javascript to ES6 Promises
https://github.com/mikehall314/es6-promisify

Last synced: about 2 months ago
JSON representation

Convert callback-based javascript to ES6 Promises

• Host: GitHub
• URL: https://github.com/mikehall314/es6-promisify
• Owner: mikehall314
• License: mit
• Created: 2014-04-15T15:23:48.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T02:31:56.000Z (over 1 year ago)
• Last Synced: 2024-04-04T08:02:53.128Z (6 months ago)
• Language: JavaScript
• Size: 546 KB
• Stars: 516
• Watchers: 8
• Forks: 36
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build Status](https://github.com/digitaldesignlabs/es6-promisify/actions/workflows/test.yml/badge.svg)

# es6-promisify

Converts callback-based functions to Promises, using a boilerplate callback function.

## Install

Install with [npm](https://npmjs.org/package/es6-promisify)

```bash

npm install es6-promisify

```

## Example

```js

const {promisify} = require("es6-promisify");

// Convert the stat function

const fs = require("fs");

const stat = promisify(fs.stat);

// Now usable as a promise!

try {

    const stats = await stat("example.txt");

    console.log("Got stats", stats);

} catch (err) {

    console.error("Yikes!", err);

}

```

## Promisify methods

```js

const {promisify} = require("es6-promisify");

// Create a promise-based version of send_command

const redis = require("redis").createClient(6379, "localhost");

const client = promisify(redis.send_command.bind(redis));

// Send commands to redis and get a promise back

try {

    const pong = await client.ping();

    console.log("Got", pong);

} catch (err) {

    console.error("Unexpected error", err);

} finally {

    redis.quit();

}

```

## Handle multiple callback arguments, with named parameters

```js

const {promisify} = require("es6-promisify");

function test(cb) {

    return cb(undefined, 1, 2, 3);

}

// Create promise-based version of test

test[promisify.argumentNames] = ["one", "two", "three"];

const multi = promisify(test);

// Returns named arguments

const result = await multi();

console.log(result); // {one: 1, two: 2, three: 3}

```

## Provide your own Promise implementation

```js

const {promisify} = require("es6-promisify");

// Now uses Bluebird

promisify.Promise = require("bluebird");

const test = promisify(cb => cb(undefined, "test"));

const result = await test();

console.log(result); // "test", resolved using Bluebird

```

### Tests

Test with tape

```bash

$ npm test

```

Published under the [MIT License](http://opensource.org/licenses/MIT).