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

@chuxingpay/koa-proxy-middleware

v2.0.2

Published

http proxy middleware of koa2

Downloads

89

Readme

koa-proxy-middleware

NPM version build status Test coverage

Middleware for koa2. Reverse proxy middleware for koa. Proxy resources on other servers, such as Java services, and other node.js applications. Based on http-proxy library.

Require

node v8.x +

Installation

NPM

Usage

koa-proxy-middleware is used to forward HTTP requests in koa middleware,it looks like the nginx in Node.
example:

const Koa = require('koa');
const Proxy = require('koa-proxy-middleware');
const app = new Koa();
const proxy = new Proxy({
  proxies: [
    {
      host: 'http://localhost:3333/',
      context: 'nginx'
    },
  ]
});
app.use(proxy);
app.listen(3000);
    

API

Options

  • proxies
    koa-proxy-middleware config option,expect Array value,Each of the config objects is a proxy combination,you should fill this option with client require context prefix and host server address.

    • host url string to be parsed with the url module
    • context Local proxy root address,required,string format
    • rewrite unrequired,Function/Boolean value. It doesn't overwrite the path when it's false.
    • proxyTimeout unrequired,Number
  • proxyTimeout
    timeout(in millis) for outgoing proxy requests. unrequired,default 30000

  • rewrite
    rewrite the url redirects function.unrequired,default () => path.replace(context, '').It's unnecessary to replace '/' path because funciton rewrite did it default in http-proxy

  • logLevel
    Log level of terminal output,includes error, warn, info, http, verbose, debug, debug, silly, it dependence on Winston package

  • handleReq
    The function will be triggered before send data. you can modify the request object of request before handle proxy.This method takes four arguments proxyReq,req,res,options

const proxy = new Proxy({
  proxies: ...,
  handleReq: proxyObj => {
    { proxyReq, req, res, options } = proxyObj;
  }
});
  • handleRes
    The function will be triggered if back response from the target server.It takes three arguments proxyRes,req,res

  • error
    The error function will be triggered when fail in request to the target server.It takes three arguments err,req,res