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

collect-express-routes

v1.0.6

Published

Collect all API routes in Express Application / Router

Downloads

4

Readme

collect-express-routes

Collect all API routes in Express Application / Router

npm Package Version

This package helps to make "sitemap" of the APIs.

Features

  • Support spying express() application and express.Router()
  • Support chainable route handlers (app.route)
  • Optionally group collected API routes by path (of different HTTP methods)

Usage Example

import express, { Request, Response } from 'express'
import {
  groupRoutesByPath,
  getSpyRoutes,
  spyRoutes,
} from 'collect-express-routes'

let app = express()
spyRoutes(app)

app.use(express.json())

// direct routing is supported
app.get('/users', echo)
app.post('/users', echo)
app.get('/users/:id', echo)
app.patch('/users/:id', echo)
app.delete('/users/:id', echo)

// using router is also supported
let memoRouter = express.Router()
memoRouter.post('/', echo)
memoRouter.get('/:id', echo)
memoRouter.patch('/:id', echo)
memoRouter.delete('/:id', echo)
app.use('/memo', memoRouter)

// chainable route handlers are also supported
app
  .route('/book')
  .get(echo) // alias for app.get('/book', echo)
  .post(echo) // alias for app.post('/book', echo)

console.log(getSpyRoutes(app))
/* output:
[
  { method: 'get', path: '/users' },
  { method: 'post', path: '/users' },
  { method: 'get', path: '/users/:id' },
  { method: 'patch', path: '/users/:id' },
  { method: 'delete', path: '/users/:id' },
  { method: 'post', path: '/memo' },
  { method: 'get', path: '/memo/:id' },
  { method: 'patch', path: '/memo/:id' },
  { method: 'delete', path: '/memo/:id' }
  { method: 'get', path: '/book' },
  { method: 'post', path: '/book' },
]
*/

console.log(groupRoutesByPath(getSpyRoutes(app)))
/* output:
{
  '/users': [ 'get', 'post' ],
  '/users/:id': [ 'get', 'patch', 'delete' ],
  '/memo': [ 'post' ],
  '/memo/:id': [ 'get', 'patch', 'delete' ],
  '/book': [ 'get', 'post' ]
}
*/

function echo(req: Request, res: Response) {
  res.json({ method: req.method, path: req.path })
}

Details see spy.spec.ts

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

  • The freedom to run the program as you wish, for any purpose
  • The freedom to study how the program works, and change it so it does your computing as you wish
  • The freedom to redistribute copies so you can help others
  • The freedom to distribute copies of your modified versions to others