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

node-flex-serve-proxy

v0.0.2

Published

Proxy Add-On for node-flex-serve

Downloads

4

Readme

node-flex-serve-proxy

A Proxy Add-On for node-flex-serve

Getting Started

To begin, you'll need to install node-flex-serve-proxy:

$ npm install node-flex-serve-proxy

node-flex-serve-proxy Config

In a node-flex-serve config file add the addons config

addons([options])

proxy

Type: Object

Options for initializing and controlling the http-proxy-middleware.

add

Please see Add-On Features.

Add-on Features

Luckily, flexibility baked into node-flex-serve makes it a snap to add-on features. You can leverage this by using the add option. The value of the option should be a Function matching the following signature:

add: (app, middleware, options) => {
  // ...
}

add Function Parameters

  • app The underlying Koa app
  • middleware An object containing accessor functions to the koa-static middleware.
  • options - The internal options object used by node-flex-serve

Import the add on middleware

const nodeServeProxy = require('node-flex-serve-proxy');
add: (app, middleware, options) => {
  // since we're manipulating the order of middleware added, we need to handle
  // adding these two internal middleware functions.
  middleware.content();

  nodeServeProxy.proxy(app, options);
}

Event Handling

You can configure the onListening function in the node-flex-serve configuration to handle the server on upgrade event.

on: {
  listening: nodeServeProxy.onListening,
}

Example

A Node Flex Serve Config file using Proxy Add-On could look like this :

const nodeServeProxy = require('node-flex-serve-proxy');

module.exports = {
  context: __dirname,
  addons: {
    proxy: {
      '/gitapi': {
        target: 'http://api.github.com',
        pathRewrite: {
          '^/gitapi': '',
        },
        changeOrigin: true,
      },
      '/swapi': {
        target: 'https://swapi.co/api',
        pathRewrite: {
          '^/swapi': '',
        },
        changeOrigin: true,
      },
    },
    add: (app, middleware, options) => {
      middleware.content();
      nodeServeProxy.proxy(app, options);
    },
  },
  on: {
    listening: nodeServeProxy.onListening,
  },
};

Contributing

We welcome your contributions! Please have a read of CONTRIBUTING.md for more information on how to get involved.

License

MIT