npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

request-promise-middleware-framework

v3.0.6

Published

A framework to intercept HTTP calls made via the request-promise HTTP client.

Downloads

3,730

Readme

request-promise-middleware-framework

A framework to intercept HTTP calls made via the request-promise HTTP client.

Installation

npm install request-promise-middleware-framework

Middleware Definition

The framework simply expects any middleware to be a function of form:

function(options, callback, next) {
  // Add custom logic here.
  next(options, callback);
}

The next() call will call the next middleware in the chain. To add any logic on the response, you can modify the callback as follows:

function(options, callback, next) {
  const _callback = (err, response, body) => {
    // Add custom response logic here.
    callback(err, response, body);
  };
  next(options, _callback);
}

If instead you want to completely short-circuit the HTTP call, you can simply call the callback and provide your own error or response:

function(options, callback, next) {
  const body = "Everything's fine."
  callback(null, { statusCode: 200, body: body }, body);
}

Using resolveWithFullResponse

While the middleware does attempt to leave request-promise as pristine as possible, the parameter resolveWithFullResponse makes that difficult. Many of the components of a pipeline may need access to the full response, and any part of the pipeline that hides the possible data is frowned upon. Therefore, the middleware framework must deal with that as a special case. As in request-promise, this can be configured on the invocation of request-promise, however the pipeline itself will not respect any further configuration of the parameter. The only difference you will experience between this and normal request-promise is that the default for this parameter is true. At invocation of request-promise, you can still set this to false.

Examples

Once you've defined your middleware, you can simply register it by creating a new framework object, and then getting the request object. If you want to use native Promises, you can do so as follows:

const rpMiddlewareFramework = new RequestPromiseMiddlewareFramework({ rp: require("request-promise") }, middleware);
const rp = rpMiddlewareFramework.getMiddlewareEnabledRequestPromise();

Or, if you want to use an alternate Promise library such as bluebird, you can do so as follows:

const bluebirdPromise = require("bluebird");
const rpMiddlewareFramework = new RequestPromiseMiddlewareFramework({ rp: require("request-promise"), PromiseDependency: bluebirdPromise }, middleware);
const rp = rpMiddlewareFramework.getMiddlewareEnabledRequestPromise();

In either case, you can then use returned rp object just like you normally would.

For a full example inside an express app, see the sample directory within this repository.

API Documentation

Go here for the latest API documentation.

License

MIT