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

pquest

v0.3.4

Published

Promisified request with persistant cookies and retry

Downloads

56

Readme

pquest is a wrapper around the popular request client that provides the following out-of-the-box:

Request Promisified

The pquest returns a promise on the results, using bluebird. Streaming is not available and all results will be buffered resolve the promise once fully loaded. The only way to get result back is to append a .then(..) function to the pquest object.

Caching

pquest can initialized with a unique key and caching object (both optional) to cache cookies across different instances of the pquest. The caching object should supply the following promisified functions .get(key) and .set(key,value). The cache is only read upon initilization and a regular cookie jar is used to maintain the cookies after that. After each request, the contents of the jar are saved into the cache.

Prequest is initiated by the following signature (only key is required):

var pquest = require('pquest')([key],[cache])

Injector function

A custom function can be injected into the pquest options (as property fn) to validate the response (and possible take action) before the results are used to resolve the promise. This function will be called with the res of request as a first variable and a retry function as a second variable, which can be called if/when the original request should be retried. A typical use-case would be to check if we are 'logged in' to the site before returning the results. If the reply indicates we are not logged in, we can execute the requests necessary to log in and subsequently retry our original request - whose results will to resolve the original promise.

If retry fails, the injector function will be called again. By default, retry will only be called twice in a row before erroring. Custom value for maxRetries can be specified in the parameters passed to pquest.

Example:

// We begin by defining the injected function
function validateLogin(res,retry) {
  // If we are not unauthorized, we simply pass on the results
  if (res.statusCode !== 401) return res;

  // otherwise we try to log-in
  return pquest({url: 'http://testsite/login', form: {username:'zjonsson',password:'abc123',method:'POST'})
    .then(retry);
}

// Now we can send a request knowing we will be logged in, if we aren't already
pquest({url:'http://testsite/myaccount',fn:validateLogin})
  .then(function(res) {
    console.log(res.body);
  });