Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    request-promise-anypublic

    Promises/A+ logo

    Request-Promise-Any

    Gitter Build Status Coverage Status Dependency Status Known Vulnerabilities

    This package is similar to request-promise but uses any-promise to let the user choose which Promise library to use.

    Please refer to the request-promise documentation. Everything applies to request-promise-any except the following:

    • Instead of using Bluebird promises this library uses the Promise library chosen by the user.
    • This library has to work with the API that all supported Promise libraries have in common. And that is the API of native ES6 promises. Mind that they have less features than Bluebird promises. In particular, the .finally(...) method is not available.

    Installation

    This module is installed via npm:

    npm install --save request
    npm install --save request-promise-any
    

    request is defined as a peer-dependency and thus has to be installed separately.

    Registering Your Preferred Promise Library

    First, install your preferred Promise library. E.g. Q:

    npm install --save q
    

    Then, register the Promise library before you require request-promise-any for the first time:

    require('any-promise/register/q')
     
    var rp = require('request-promise-any')

    For a list of supported Promise libraries and advanced registration features read the documentation of any-promise.

    Migration from request-promise to request-promise-any

    1. Go through the migration instructions to upgrade to request-promise v4.
    2. Ensure that you don't use Bluebird-specific features on the promise returned by your request calls. In particular, you can't use .finally(...) anymore.
    3. Follow the registration instructions above.
    4. You are done.

    Contributing

    To set up your development environment:

    1. clone the repo to your desktop,
    2. in the shell cd to the main folder,
    3. hit npm install,
    4. hit npm install gulp -g if you haven't installed gulp globally yet, and
    5. run gulp dev. (Or run node ./node_modules/.bin/gulp dev if you don't want to install gulp globally.)

    gulp dev watches all source files and if you save some changes it will lint the code and execute all tests. The test coverage report can be viewed from ./coverage/lcov-report/index.html.

    If you want to debug a test you should use gulp test-without-coverage to run all tests without obscuring the code by the test coverage instrumentation.

    Change History

    • v1.0.5 (2017-09-22)
    • v1.0.4 (2017-05-07)
    • v1.0.3 (2016-08-08)
      • Renamed internally used package @request/promise-core to request-promise-core because there where too many issues with the scoped package name
    • v1.0.2 (2016-07-18)
      • Fix for using with module bundlers like Webpack and Browserify
    • v1.0.1 (2016-07-17)
      • Fixed @request/promise-core version for safer versioning
    • v1.0.0 (2016-07-15)

    License (ISC)

    In case you never heard about the ISC license it is functionally equivalent to the MIT license.

    See the LICENSE file for details.

    install

    npm i request-promise-any

    Downloadslast 7 days

    18,875

    version

    1.0.5

    license

    ISC

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar