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

@yr/agent

v5.0.4

Published

HTTP request agent

Downloads

24

Readme

NPM Version Build Status

Extension to superagent to support collapsing request queues, response duration, and a status code of 504 for timedout requests.

Usage

const agent = require('@yr/agent');

agent
  .get('http://some/api')
  .timeout(1000)
  .retry(3)
  .then((res) => {
    console.log(res.body);
    console.log(res.duration);
  })
  .catch((err) => {
    // handle error...
  });

API

get(url, options): GET request for url. Returns superagent Request instance. Behaviour is configurable with the following options properties:

  • abort: abort existing (outstanding) request to same url (default false)
  • id: optional string for tagging request
  • ignoreQuery: ignore query parameters of url when matching existing, oustanding requests for the same url (default false)

Default behaviour is to return a cached Request instance for the same url (request collapsing). Setting both abort and ignoreQuery to true will automatically abort an outstanding request with a different query parameter:

agent
  .get('http://some/api?search=foo')
  .then((res) => {
    // Aborted, won't fire
  });
agent
  .get('http://some/api?search=bar')
  .then((res) => {
    console.log(res.body);
  });

Although the full Superagent API is supported, it's recommended to use then() (Promises) instead of end() to allow for request collapsing

abortAll([filter]): abort all outstanding requests. Takes optional string or function filter. If filter is defined as a string, only aborts requests that are tagged with options.id. If filter is defined as function, only aborts requests that return true for filter(req).

agent
  .get('http://some/api', { id: 'foo' })
  .then((res) => {
    // Aborted, won't fire
  });

agent.abortAll('foo');