{"id":17109273,"url":"https://github.com/kevinoid/promise-nodeify","last_synced_at":"2025-04-13T03:19:37.954Z","repository":{"id":6287454,"uuid":"52988989","full_name":"kevinoid/promise-nodeify","owner":"kevinoid","description":"Call a Node-style callback with the resolution value or rejection cause of a Promise without the common pitfalls.","archived":false,"fork":false,"pushed_at":"2024-12-03T23:38:17.000Z","size":1015,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T20:21:16.844Z","etag":null,"topics":["nodeify","nodejs","promise-nodeify"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevinoid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-02T19:11:39.000Z","updated_at":"2024-12-03T23:38:15.000Z","dependencies_parsed_at":"2023-10-03T02:59:45.949Z","dependency_job_id":"e3feb247-cf56-46a6-9c4c-f83ec3bdcf8d","html_url":"https://github.com/kevinoid/promise-nodeify","commit_stats":{"total_commits":465,"total_committers":5,"mean_commits":93.0,"dds":0.05161290322580647,"last_synced_commit":"aa0e73d90d380563ae26bd897783beac0e12d4ac"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fpromise-nodeify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fpromise-nodeify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fpromise-nodeify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinoid%2Fpromise-nodeify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinoid","download_url":"https://codeload.github.com/kevinoid/promise-nodeify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248658210,"owners_count":21140897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodeify","nodejs","promise-nodeify"],"created_at":"2024-10-14T16:22:43.596Z","updated_at":"2025-04-13T03:19:37.934Z","avatar_url":"https://github.com/kevinoid.png","language":"JavaScript","funding_links":[],"categories":["Convenience Utilities"],"sub_categories":["Others"],"readme":"promise-nodeify\n===============\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/kevinoid/promise-nodeify/node.js.yml?branch=main\u0026style=flat\u0026label=build)](https://github.com/kevinoid/promise-nodeify/actions?query=branch%3Amain)\n[![Coverage](https://img.shields.io/codecov/c/github/kevinoid/promise-nodeify/main.svg?style=flat)](https://app.codecov.io/gh/kevinoid/promise-nodeify/branch/main)\n[![Dependency Status](https://img.shields.io/librariesio/release/npm/promise-nodeify.svg?style=flat)](https://libraries.io/npm/promise-nodeify)\n[![Supported Node Version](https://img.shields.io/node/v/promise-nodeify.svg?style=flat)](https://www.npmjs.com/package/promise-nodeify)\n[![Version on NPM](https://img.shields.io/npm/v/promise-nodeify.svg?style=flat)](https://www.npmjs.com/package/promise-nodeify)\n\nCall a Node-style callback with the resolution value or rejection cause of a\nPromise without the common pitfalls.\n\n## Introductory Example\n\n```js\nvar promiseNodeify = require('promise-nodeify');\n\n// Function which returns a Promise\nfunction returnsPromise() {\n  return new Promise(function(resolve, reject) {\n    resolve(42);\n  });\n}\n\n// Function which takes an optional node-style callback\nfunction takesCallback(callback) {\n  var promise = returnsPromise();\n  // if callback is not a function, promise is returned as-is\n  // otherwise callback will be called when promise is resolved or rejected\n  // promise will not cause unhandledRejection if callback is a function\n  return promiseNodeify(promise, callback);\n}\n```\n\n## Features\n\nThe important features of `nodeify` as compared to naive implementations:\n\n* Creates `Error` for falsey rejection causes.  Since Promises may resolve or\n  reject without providing a value or cause, the callback would have no way to\n  distinguish success from failure.  This module ensures the error argument is\n  always truthy, substituting an `Error` when the rejection cause is falsey\n  (and passing the original value as the `.cause` property, as bluebird does).\n* Exceptions thrown by callback cause `uncaughtException` as they would for\n  other callbacks (unlike passing callback to `.then`, which causes\n  `unhandledRejection` or swallows them).\n* The callback handles the promise rejection, preventing `unhandledRejection`\n  (unlike if the promise were ignored and callback invoked directly).\n* Reduces confusion by only returning a Promise when no callback is given\n  (as opposed to returning the promise argument, which creates uncertainty\n  about `unhandledRejection`s and multiple threads of control - or returning\n  the result passing the callback to `.then`, which resolves to the callback\n  result).\n\n## Behavior Comparison\n\nThis module provides similar behavior to several popular promise libraries in\na promise-library-agnostic way which only requires the ES6 promise\nfunctionality subset.  However, these existing implementations differ in\nsubtle ways.  A brief comparison:\n\nBehavior                  | this module           | [bluebird `#asCallback`][bb-ascallback]      | [es-nodeify][es-nodeify]              | [nodeify][nodeify]                    | [then `#nodeify`][then-nodeify] | [Un-thenify][unthenify]\u003csup\u003e[1](#note-1)\u003c/sup\u003e | [when.js `.bindCallback`][when-bindcallback]\n--------------------------|-----------------------|----------------------------------------------|---------------------------------------|---------------------------------------|---------------------------------|------------------------------------------------|---------------------------------------------\nreturns (with `function`) | `undefined`           | `this` `Promise`\u003csup\u003e[2](#note-2)\u003c/sup\u003e      | `undefined`                           | `Promise\u003cundefined\u003e`                  | `undefined`                     | `undefined`                                    | `when(promise)`\nreturns (with falsey)     | `promise`             | `promise`                                    | `promise`                             | `Promise\u003cundefined\u003e`                  | `promise`                       | `undefined` with `unhandledRejection`          | `when(promise)`\nreturns (non-function)    | `promise`             | `promise`                                    | `undefined` with `unhandledRejection` | `promise`                             | `promise`                       | `undefined` with `unhandledRejection`          | `when(promise)` with `uncaughtException`\ncallback exception        | `uncaughtException`   | `uncaughtException`                          | `unhandledRejection`                  | `uncaughtException`                   | `uncaughtException`             | `unhandledRejection`                           | `uncaughtException`\nfalsey cause              | `Error` with `.cause` | `Error` with `.cause`\u003csup\u003e[3](#note-3)\u003c/sup\u003e | `Error`                               | falsey cause                          | falsey cause                    | `TypeError`                                    | falsey cause\nreject argument length    | 1                     | 1                                            | 1                                     | 1                                     | 1                               | 1                                              | 2\nresolve argument length   | 2                     | `undefined` ? 1 : 2\u003csup\u003e[4](#note-4)\u003c/sup\u003e   | 2                                     | 2                                     | 2                               | 2                                              | 2\nextra argument            | ignored               | options\u003csup\u003e[5](#note-5)\u003c/sup\u003e               | ignored                               | ignored                               | `this` of callback              | ignored                                        | ignored\n\nNotes:\n\n1. \u003ca id=\"note-1\" name=\"note-2\" /\u003e Un-thenify serves a similar purpose, but\n   wraps the Promise-returning function rather than taking the Promise as an\n   argument.\n2. \u003ca id=\"note-2\" name=\"note-3\" /\u003e Temporarily reverted in\n   https://github.com/petkaantonov/bluebird/issues/151 and restored in\n   https://github.com/petkaantonov/bluebird/issues/168\n3. \u003ca id=\"note-3\" name=\"note-4\" /\u003e In response to\n   https://github.com/petkaantonov/bluebird/issues/434\n4. \u003ca id=\"note-4\" name=\"note-5\" /\u003e In response to\n   https://github.com/petkaantonov/bluebird/issues/170\n5. \u003ca id=\"note-5\" name=\"note-6\" /\u003e Supports the `spread` boolean option to\n   pass `Array` values as separate arguments to `callback`.\n\n## Performance Comparison\n\nThese benchmarks were done using the [benchmark/index.js](benchmark/index.js)\nscript on an `Intel(R) Core(TM) i5-3320M CPU @ 2.60GHz` with Node v4.3.1 on\nLinux and the following module versions:\n\n| Module                                           | Version |\n|--------------------------------------------------|---------|\n| [`benchmark`][npm-benchmark]                     | 2.1.0   |\n| [`bluebird`][npm-bluebird]                       | 3.3.3   |\n| [`cli-table`][npm-cli-table]                     | 0.3.1   |\n| [`es-nodeify`][npm-es-nodeify]                   | 1.0.0   |\n| [`microtime`][npm-microtime]                     | 2.0.0   |\n| [`native-promise-only`][npm-native-promise-only] | 0.8.1   |\n| [`nodeify`][npm-nodeify]                         | 1.0.0   |\n| [`pinkie-promise`][npm-pinkie-promise]           | 2.0.0   |\n| [`promise`][npm-promise]                         | 7.1.1   |\n| [`q`][npm-q]                                     | 1.4.1   |\n| [`rsvp`][npm-rsvp]                               | 3.2.1   |\n| [`unthenify`][npm-unthenify]                     | 1.0.1   |\n| [`when`][npm-when]                               | 3.7.7   |\n\n### Nodeify Resolved Promise\n\nPerformance (in operations per second) of calling `nodeify` on a resolved\npromise (larger is better):\n\n| ops/sec           | bluebird      | native      | npo         | pinkie      | q          | rsvp          | then          | when          |\n|-------------------|--------------:|------------:|------------:|------------:|-----------:|--------------:|--------------:|--------------:|\n| bluebird#nodeify  | 1,922,721.987 | TypeError   | TypeError   | TypeError   | TypeError  | TypeError     | TypeError     | TypeError     |\n| es-nodeify        | 1,345,702.588 | 506,103.345 | 510,887.217 | 534,013.961 | 68,915.816 | 1,974,250.737 | 2,096,468.119 | 1,756,177.934 |\n| nodeify           | 147,481.019   | 251,414.264 | 251,535.145 | 253,880.998 | 58,504.098 | 1,355,812.482 | 1,102,467.756 | 1,160,226.624 |\n| promiseNodeify    | 1,586,092.279 | 481,842.79  | 452,529.247 | 455,657.062 | 66,045.273 | 2,108,607.126 | 2,370,823.723 | 1,942,722.539 |\n| then#nodeify      | 136,716.987   | 202,670.23  | 225,297.257 | 231,042.286 | 56,384.953 | 764,719.55    | 1,320,158.92  | 739,062.155   |\n| unthenify         | 100,638.922   | 79,097.99   | 80,488.25   | 78,298.365  | 40,683.82  | 103,125.162   | 100,618.139   | 101,887.997   |\n| when.bindCallback | 823.326       | 856.669     | 842.975     | 834.864     | 748.669    | 847.556       | 850.316       | 839.995       |\n\n\u003c!-- GitHub sanitizes my attempts to make this toggleable.  Hide for now.\n    bluebird#nodeify with bluebird x 1,922,722 ops/sec ±1.71% (80 runs sampled)\n    bluebird#nodeify with npo: TypeError: this._then is not a function\n    bluebird#nodeify with pinkie: TypeError: this._then is not a function\n    bluebird#nodeify with q: TypeError: this._then is not a function\n    bluebird#nodeify with rsvp: TypeError: this._then is not a function\n    bluebird#nodeify with then: TypeError: this._then is not a function\n    bluebird#nodeify with when: TypeError: this._then is not a function\n    bluebird#nodeify with native: TypeError: this._then is not a function\n    es-nodeify with bluebird x 1,345,703 ops/sec ±0.84% (81 runs sampled)\n    es-nodeify with npo x 510,887 ops/sec ±1.32% (85 runs sampled)\n    es-nodeify with pinkie x 534,014 ops/sec ±0.92% (84 runs sampled)\n    es-nodeify with q x 68,916 ops/sec ±2.99% (70 runs sampled)\n    es-nodeify with rsvp x 1,974,251 ops/sec ±0.84% (85 runs sampled)\n    es-nodeify with then x 2,096,468 ops/sec ±0.77% (84 runs sampled)\n    es-nodeify with when x 1,756,178 ops/sec ±3.48% (82 runs sampled)\n    es-nodeify with native x 506,103 ops/sec ±1.36% (87 runs sampled)\n    nodeify with bluebird x 147,481 ops/sec ±2.80% (71 runs sampled)\n    nodeify with npo x 251,535 ops/sec ±2.60% (77 runs sampled)\n    nodeify with pinkie x 253,881 ops/sec ±2.53% (67 runs sampled)\n    nodeify with q x 58,504 ops/sec ±4.30% (67 runs sampled)\n    nodeify with rsvp x 1,355,812 ops/sec ±2.98% (81 runs sampled)\n    nodeify with then x 1,102,468 ops/sec ±2.09% (81 runs sampled)\n    nodeify with when x 1,160,227 ops/sec ±3.95% (79 runs sampled)\n    nodeify with native x 251,414 ops/sec ±3.02% (77 runs sampled)\n    promiseNodeify with bluebird x 1,586,092 ops/sec ±1.94% (81 runs sampled)\n    promiseNodeify with npo x 452,529 ops/sec ±0.52% (84 runs sampled)\n    promiseNodeify with pinkie x 455,657 ops/sec ±0.50% (85 runs sampled)\n    promiseNodeify with q x 66,045 ops/sec ±4.14% (71 runs sampled)\n    promiseNodeify with rsvp x 2,108,607 ops/sec ±3.66% (81 runs sampled)\n    promiseNodeify with then x 2,370,824 ops/sec ±1.08% (82 runs sampled)\n    promiseNodeify with when x 1,942,723 ops/sec ±0.79% (86 runs sampled)\n    promiseNodeify with native x 481,843 ops/sec ±0.41% (87 runs sampled)\n    then#nodeify with bluebird x 136,717 ops/sec ±1.83% (82 runs sampled)\n    then#nodeify with npo x 225,297 ops/sec ±2.92% (81 runs sampled)\n    then#nodeify with pinkie x 231,042 ops/sec ±2.14% (80 runs sampled)\n    then#nodeify with q x 56,385 ops/sec ±3.88% (75 runs sampled)\n    then#nodeify with rsvp x 764,720 ops/sec ±3.37% (81 runs sampled)\n    then#nodeify with then x 1,320,159 ops/sec ±2.67% (81 runs sampled)\n    then#nodeify with when x 739,062 ops/sec ±0.78% (85 runs sampled)\n    then#nodeify with native x 202,670 ops/sec ±6.14% (74 runs sampled)\n    unthenify with bluebird x 100,639 ops/sec ±2.24% (84 runs sampled)\n    unthenify with npo x 80,488 ops/sec ±2.78% (84 runs sampled)\n    unthenify with pinkie x 78,298 ops/sec ±3.08% (81 runs sampled)\n    unthenify with q x 40,684 ops/sec ±3.94% (73 runs sampled)\n    unthenify with rsvp x 103,125 ops/sec ±0.78% (84 runs sampled)\n    unthenify with then x 100,618 ops/sec ±3.56% (83 runs sampled)\n    unthenify with when x 101,888 ops/sec ±0.46% (82 runs sampled)\n    unthenify with native x 79,098 ops/sec ±3.09% (83 runs sampled)\n    when.bindCallback with bluebird x 823 ops/sec ±1.21% (76 runs sampled)\n    when.bindCallback with npo x 843 ops/sec ±0.96% (75 runs sampled)\n    when.bindCallback with pinkie x 835 ops/sec ±0.97% (75 runs sampled)\n    when.bindCallback with q x 749 ops/sec ±1.55% (73 runs sampled)\n    when.bindCallback with rsvp x 848 ops/sec ±0.94% (77 runs sampled)\n    when.bindCallback with then x 850 ops/sec ±0.86% (76 runs sampled)\n    when.bindCallback with when x 840 ops/sec ±0.86% (76 runs sampled)\n    when.bindCallback with native x 857 ops/sec ±1.41% (38 runs sampled)\n--\u003e\n\n### Nodeify Rejected Promise\n\nPerformance (in operations per second) of calling `nodeify` on a rejected\npromise (larger is better):\n\n\n| ops/sec           | bluebird      | native      | npo         | pinkie      | q          | rsvp          | then          | when          |\n|-------------------|--------------:|------------:|------------:|------------:|-----------:|--------------:|--------------:|--------------:|\n| bluebird#nodeify  | 1,889,496.469 | TypeError   | TypeError   | TypeError   | TypeError  | TypeError     | TypeError     | TypeError     |\n| es-nodeify        | 1,247,981.228 | 520,349.959 | 455,337.77  | 466,964.692 | 64,703.247 | 2,182,281.005 | 2,062,330.035 | 1,889,184.935 |\n| nodeify           | 147,454.87    | 325,956.476 | 326,958.556 | 325,971.637 | 53,878.098 | 1,232,726.201 | 952,338.091   | 926,626.949   |\n| promiseNodeify    | 1,170,756.604 | 465,186.326 | 478,343.59  | 489,024.094 | 62,905.801 | 2,097,277.371 | 1,928,682.943 | 1,497,451.328 |\n| then#nodeify      | 131,588.987   | 241,627.02  | 246,557.24  | 245,427.553 | 49,655.492 | 684,232.864   | 1,178,175.996 | 634,041.464   |\n| unthenify         | 96,359.916    | 82,291.679  | 82,507.055  | 83,324.584  | 38,842.741 | 96,432.332    | 97,113.05     | 99,892.099    |\n| when.bindCallback | 822.083       | 837.698     | 848.358     | 851.348     | 789.546    | 854.184       | 844.102       | 851.644       |\n\n\u003c!-- GitHub sanitizes my attempts to make this toggleable.  Hide for now.\n    bluebird#nodeify with bluebird x 1,889,496 ops/sec ±1.37% (83 runs sampled)\n    bluebird#nodeify with npo: TypeError: this._then is not a function\n    bluebird#nodeify with pinkie: TypeError: this._then is not a function\n    bluebird#nodeify with q: TypeError: this._then is not a function\n    bluebird#nodeify with rsvp: TypeError: this._then is not a function\n    bluebird#nodeify with then: TypeError: this._then is not a function\n    bluebird#nodeify with when: TypeError: this._then is not a function\n    bluebird#nodeify with native: TypeError: this._then is not a function\n    es-nodeify with bluebird x 1,247,981 ops/sec ±1.41% (78 runs sampled)\n    es-nodeify with npo x 455,338 ops/sec ±3.80% (85 runs sampled)\n    es-nodeify with pinkie x 466,965 ops/sec ±2.77% (81 runs sampled)\n    es-nodeify with q x 64,703 ops/sec ±3.54% (73 runs sampled)\n    es-nodeify with rsvp x 2,182,281 ops/sec ±2.07% (83 runs sampled)\n    es-nodeify with then x 2,062,330 ops/sec ±0.67% (83 runs sampled)\n    es-nodeify with when x 1,889,185 ops/sec ±0.62% (85 runs sampled)\n    es-nodeify with native x 520,350 ops/sec ±0.39% (86 runs sampled)\n    nodeify with bluebird x 147,455 ops/sec ±2.51% (74 runs sampled)\n    nodeify with npo x 326,959 ops/sec ±2.44% (81 runs sampled)\n    nodeify with pinkie x 325,972 ops/sec ±2.19% (82 runs sampled)\n    nodeify with q x 53,878 ops/sec ±4.86% (66 runs sampled)\n    nodeify with rsvp x 1,232,726 ops/sec ±4.10% (81 runs sampled)\n    nodeify with then x 952,338 ops/sec ±0.98% (83 runs sampled)\n    nodeify with when x 926,627 ops/sec ±5.41% (69 runs sampled)\n    nodeify with native x 325,956 ops/sec ±3.21% (77 runs sampled)\n    promiseNodeify with bluebird x 1,170,757 ops/sec ±2.39% (84 runs sampled)\n    promiseNodeify with npo x 478,344 ops/sec ±1.87% (84 runs sampled)\n    promiseNodeify with pinkie x 489,024 ops/sec ±0.47% (86 runs sampled)\n    promiseNodeify with q x 62,906 ops/sec ±4.73% (69 runs sampled)\n    promiseNodeify with rsvp x 2,097,277 ops/sec ±2.18% (84 runs sampled)\n    promiseNodeify with then x 1,928,683 ops/sec ±0.99% (85 runs sampled)\n    promiseNodeify with when x 1,497,451 ops/sec ±0.47% (83 runs sampled)\n    promiseNodeify with native x 465,186 ops/sec ±3.41% (85 runs sampled)\n    then#nodeify with bluebird x 131,589 ops/sec ±2.36% (81 runs sampled)\n    then#nodeify with npo x 246,557 ops/sec ±1.59% (88 runs sampled)\n    then#nodeify with pinkie x 245,428 ops/sec ±2.68% (82 runs sampled)\n    then#nodeify with q x 49,655 ops/sec ±4.59% (70 runs sampled)\n    then#nodeify with rsvp x 684,233 ops/sec ±0.56% (86 runs sampled)\n    then#nodeify with then x 1,178,176 ops/sec ±0.77% (83 runs sampled)\n    then#nodeify with when x 634,041 ops/sec ±2.52% (83 runs sampled)\n    then#nodeify with native x 241,627 ops/sec ±2.28% (86 runs sampled)\n    unthenify with bluebird x 96,360 ops/sec ±0.54% (85 runs sampled)\n    unthenify with npo x 82,507 ops/sec ±1.38% (85 runs sampled)\n    unthenify with pinkie x 83,325 ops/sec ±0.33% (85 runs sampled)\n    unthenify with q x 38,843 ops/sec ±3.26% (75 runs sampled)\n    unthenify with rsvp x 96,432 ops/sec ±4.63% (80 runs sampled)\n    unthenify with then x 97,113 ops/sec ±2.47% (83 runs sampled)\n    unthenify with when x 99,892 ops/sec ±0.48% (85 runs sampled)\n    unthenify with native x 82,292 ops/sec ±0.39% (85 runs sampled)\n    when with bluebird x 822 ops/sec ±1.11% (78 runs sampled)\n    when with npo x 848 ops/sec ±0.90% (77 runs sampled)\n    when with pinkie x 851 ops/sec ±0.99% (74 runs sampled)\n    when with q x 790 ops/sec ±1.72% (73 runs sampled)\n    when with rsvp x 854 ops/sec ±0.98% (75 runs sampled)\n    when with then x 844 ops/sec ±0.94% (74 runs sampled)\n    when with when x 852 ops/sec ±0.93% (75 runs sampled)\n    when with native x 838 ops/sec ±0.94% (76 runs sampled)\n--\u003e\n\n## Installation\n\n### NPM\n\n[This package](https://www.npmjs.com/package/promise-nodeify) can be installed\nusing [npm](https://www.npmjs.com/) by running:\n\n```sh\nnpm install promise-nodeify\n```\n\n### Browser\n\nThis package can be installed using [bower](http://bower.io/) by running:\n\n```sh\nbower install promise-nodeify\n```\n\n### Without Package Manager\n\nThis module is also available with a [UMD](https://github.com/umdjs/umd)\nloader, both minified and un-minified, in the [`dist` directory](dist).  They\ncan be downloaded, self-hosted, or loaded from a CDN.  To use the [RawGit\nCDN](https://rawgit.com/), use the following (X)HTML:\n\n```html\n\u003cscript src=\"https://cdn.rawgit.com/kevinoid/promise-nodeify/v0.1.0/dist/promise-nodeify.min.js\"\u003e\u003c/script\u003e\n```\n\n## Recipes\n\n### Delegate to `Promise.prototype.nodeify`\n\nIf the behavior differences discussed in the [Behavior\nComparison](#behavior-comparison) section (and any future differences which\nmay occur) are not significant to your use case and you are interested in\ntaking advantage of the potential [performance\nbenefit](#performance-comparison) of the implementation provided by the\npromise library, use the `.delegated` function:\n\n```js\n// Using .delegated delegates to .nodeify on the promise argument when present\nvar promiseNodeify = require('promise-nodeify').delegated;\n\nfunction returnsPromise() {\n  return new Promise(function(resolve, reject) {\n    resolve(42);\n  });\n}\n\nfunction takesCallback(callback) {\n  var promise = returnsPromise();\n  return promiseNodeify(promise, callback);\n}\n```\n\n### Polyfill `Promise.prototype.nodeify`\n\nTo polyfill the `.nodeify` (or `.asCallback`) method for a Promise library,\nassign the `.nodeifyThis` function to `Promise.prototype.nodeify` as follows:\n\n```js\nPromise.prototype.nodeify = require('promise-nodeify').nodeifyThis;\n\nfunction returnsPromise() {\n  return new Promise(function(resolve, reject) {\n    resolve(42);\n  });\n}\n\nfunction takesCallback(callback) {\n  var promise = returnsPromise();\n  return promise.nodeify(callback);\n}\n```\n\nMore examples can be found in the [test\nspecifications](https://kevinoid.github.io/promise-nodeify/spec).\n\n## API Docs\n\nFor a description of the available functions and their arguments, see the [API\nDocumentation](https://kevinoid.github.io/promise-nodeify/api).\n\n## Contributing\n\nContributions are appreciated.  Contributors agree to abide by the [Contributor\nCovenant Code of\nConduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).\nIf this is your first time contributing to a Free and Open Source Software\nproject, consider reading [How to Contribute to Open\nSource](https://opensource.guide/how-to-contribute/)\nin the Open Source Guides.\n\nThe `dist` files are only updated for releases, so please don't include them\nin pull requests.\n\nIf the desired change is large, complex, backwards-incompatible, can have\nsignificantly differing implementations, or may not be in scope for this\nproject, opening an issue before writing the code can avoid frustration and\nsave a lot of time and effort.\n\n## License\n\nThis project is available under the terms of the [MIT License](LICENSE.txt).\nSee the [summary at TLDRLegal](https://tldrlegal.com/license/mit-license).\n\n[bb-ascallback]: http://bluebirdjs.com/docs/api/ascallback.html\n[es-nodeify]: https://github.com/robbertkl/es-nodeify\n[nodeify]: https://github.com/then/nodeify\n[npm-benchmark]: https://www.npmjs.com/package/benchmark\n[npm-bluebird]: https://www.npmjs.com/package/bluebird\n[npm-cli-table]: https://www.npmjs.com/package/cli-table\n[npm-es-nodeify]: https://www.npmjs.com/package/es-nodeify\n[npm-microtime]: https://www.npmjs.com/package/microtime\n[npm-native-promise-only]: https://www.npmjs.com/package/native-promise-only\n[npm-nodeify]: https://www.npmjs.com/package/nodeify\n[npm-pinkie-promise]: https://www.npmjs.com/package/pinkie-promise\n[npm-promise]: https://www.npmjs.com/package/promise\n[npm-q]: https://www.npmjs.com/package/q\n[npm-rsvp]: https://www.npmjs.com/package/rsvp\n[npm-unthenify]: https://www.npmjs.com/package/unthenify\n[npm-when]: https://www.npmjs.com/package/when\n[then-nodeify]: https://github.com/then/promise#promisenodeifycallback\n[unthenify]: https://github.com/blakeembrey/unthenify\n[when-bindcallback]: https://github.com/cujojs/when/blob/master/docs/api.md#nodebindcallback\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinoid%2Fpromise-nodeify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinoid%2Fpromise-nodeify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinoid%2Fpromise-nodeify/lists"}