diff options
author | Rebecca Turner <me@re-becca.org> | 2018-04-20 18:26:37 -0700 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2018-05-24 23:24:45 -0700 |
commit | 468ab4519e1b92473acefb22801497a1af6aebae (patch) | |
tree | bdac1d062cd4b094bde3a21147bab5d82c792ece /deps/npm/node_modules/es6-promisify/README.md | |
parent | ac8226115e2192a7a46ba07789fa5136f74223e1 (diff) | |
download | android-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.tar.gz android-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.tar.bz2 android-node-v8-468ab4519e1b92473acefb22801497a1af6aebae.zip |
deps: upgrade npm to 6.1.0
PR-URL: https://github.com/nodejs/node/pull/20190
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Diffstat (limited to 'deps/npm/node_modules/es6-promisify/README.md')
-rw-r--r-- | deps/npm/node_modules/es6-promisify/README.md | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/deps/npm/node_modules/es6-promisify/README.md b/deps/npm/node_modules/es6-promisify/README.md new file mode 100644 index 0000000000..4141cc840f --- /dev/null +++ b/deps/npm/node_modules/es6-promisify/README.md @@ -0,0 +1,89 @@ +[![Travis CI](https://travis-ci.org/digitaldesignlabs/es6-promisify.svg)](https://travis-ci.org/digitaldesignlabs/es6-promisify) + +# es6-promisify + +Converts callback-based functions to Promise-based functions. + +## Install + +Install with [npm](https://npmjs.org/package/es6-promisify) + +```bash +npm install --save es6-promisify +``` + +## Example + +```js +"use strict"; + +// Declare variables +const promisify = require("es6-promisify"); +const fs = require("fs"); + +// Convert the stat function +const stat = promisify(fs.stat); + +// Now usable as a promise! +stat("example.txt").then(function (stats) { + console.log("Got stats", stats); +}).catch(function (err) { + console.error("Yikes!", err); +}); +``` + +## Promisify methods +```js +"use strict"; + +// Declare variables +const promisify = require("es6-promisify"); +const redis = require("redis").createClient(6379, "localhost"); + +// Create a promise-based version of send_command +const client = promisify(redis.send_command, redis); + +// Send commands to redis and get a promise back +client("ping").then(function (pong) { + console.log("Got", pong); +}).catch(function (err) { + console.error("Unexpected error", err); +}).then(function () { + redis.quit(); +}); +``` + +## Handle callback multiple arguments +```js +"use strict"; + +// Declare functions +function test(cb) { + return cb(undefined, 1, 2, 3); +} + +// Declare variables +const promisify = require("es6-promisify"); + +// Create promise-based version of test +const single = promisify(test); +const multi = promisify(test, {multiArgs: true}); + +// Discards additional arguments +single().then(function (result) { + console.log(result); // 1 +}); + +// Returns all arguments as an array +multi().then(function (result) { + console.log(result); // [1, 2, 3] +}); +``` + +### Tests +Test with nodeunit +```bash +$ npm test +``` + +Published under the [MIT License](http://opensource.org/licenses/MIT). |