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

koa-multifetch

v0.6.1

Published

A Koa.js middleware for performing internal batch requests

Downloads

9

Readme

koa-multifetch

A simple koa.js middleware to multiplex several HTTP requests into one. Very useful on mobile devices where latency can kill performance. Based on Facebook's Batch Requests philosophy, and inspired by multifetch for Express.

Installation

npm install koa-multifetch

After installing the package, mount the middleware on any URL, using koa-route. For example, to add /multi as a multifetch endpoint:

var multifetch = require('koa-multifetch')();
var koaRoute = require('koa-route');
app.use(koaRoute.post('/multi', multifetch));

By default koa-multifetch use relative url. In this example all request will be prepended with "/multi".

But koa-multifetch can take an object of options as parameter, object that can have two properties:

  1. If you want to allow koa-multifetch to send request anywhere on your site, enable absoluteUrl option with absolute property by calling
var multifetch = require('koa-multifetch')({absolute: true}); // enable absolute url, absolute is false by default
  1. If you want to force koa-multifetch to send request on a specific host (for exemple if you are behind a load balancer on level 7), enable custom host option with header_host property by calling
var multifetch = require('koa-multifetch')({header_host: 'http://localhost:3000'}); // set a custom host for multiFetch requests

koa-multifetch can be mounted both as a GET and POST route.

Usage

Send a request to the route where the middleware is listening, passing the requests to fetch in parallel as a JSON object in the request body. For instance, to fetch /products/1 and /users in parallel, make the following request:

POST /multi HTTP/1.1
Content-Type: application/json
{
    "product": "/products/1",
    "all_users": "/users"
}

The middleware will call both HTTP resources, and return a response with a composite body once all the requests are fetched:

{
    "product": {
        "code":"200",
        "headers":[
            { "name": "Content-Type", "value": "text/javascript; charset=UTF-8" }
        ],
        "body": "{ id: 1, name: \"ipad2\", stock: 34 }"
    },
    "all_users": {
        "code":"200",
        "headers":[
            { "name": "Content-Type", "value": "text/javascript; charset=UTF-8" }
        ],
        "body": "[{ id: 2459, login: \"john\" }, { id: 7473, login: \"jane\" }]"
    }
}

Any header present in the multifetch request will be automatically added to all sub-requests.

Tip: When mounted as a GET route, koa-multifetch reads the query parameters to determine the requests to fetch:

GET /multi?product=/product/1&all_users=/users HTTP/1.1

License

koa-multifetch is licensed under the MIT Licence, courtesy of marmelab.