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

@routes/index

v1.2.1

Published

๐Ÿ“‡ An index of routes exposed by Express app

Downloads

14

Readme

@routes/index

๐Ÿ“‡ An index of routes exposed by Express app

const app = express();
const index = require('@routes/index');

...

const filter = (method, path) => {
	if (/patch/i.test(method)) { return false; }
	if (path.endsWith('ping')) { return false; }
	return true;
};
index(app, filter);

Arguments and options

  • First argument is an Expressjs app instance.
  • Second, optional, argument is a named options object. All options are optional

| Name | Type | Meaning | - | - | - | filter | {Function} | Filter routes by method or path | should | {Function} | For 'route' method, should it display the 404 list page or simply call next middleware

filter method accepts two arguments: method (lowercase), and path - respectfully (e.g. :'get', '/users/:user_id')

const filter = (method, path) => path.starsWith('/api');

should method accepts two arguments: request and response - the express middleware arguments

const should = (request, response) => request.path.startsWith('/api');

Usage

Example express app setup

const express = require('express');

const app = express();
app.get('/ping', ...);
app.get('/users/:user_id', ...);
app.patch('/users/:user_id', ...);
app.delete('/users/:user_id', ...);
app.get('/users', ...);
app.post('/users', ...);

Get an index of all available routes

const index = require('@routes/index');

index(app);

| Example | - |

Get a flat list of routes (no methods) (* de-duped)

const {flat} = index(app);

flat // ['/users', '/users/:user_id']

Show API consumers an index for 404 message

const {route} = index(
	app,

	// filter paths from the list
	{
		filter: (method, path) => !['/ping', '*'].includes(path),
		should: (request, response) => !request.is('html'),
	}
);
app.all('*', route);

| Example | - |

Result

< HTTP/1.1 404 Not Found
< Content-Type: text/plain; charset=utf-8
< Content-Length: 290
< Date: Wed, 17 Apr 2019 21:19:32 GMT
< Connection: keep-alive
<
{ [290 bytes data]
404 error - Could not find route [GET] /missing
Here is a index of available routes:
- [GET] /users
- [POST] /users
- [GET] /users/:user_id
- [PATCH] /users/:user_id
- [DELETE] /users/:user_id