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

bearded-route-list

v0.1.4

Published

> I just want to know what the hell I'm doing

Downloads

7

Readme

#Bearded Route List

I just want to know what the hell I'm doing

This attaches the express.Router() instance to given endpoints inside of routes along with building a list of all available endpoints along with the methods. See Example for use case and sample output

##Usage

yarn add bearded-route-list

##Import/Require

import baseList from 'bearded-route-list'

// OR

const baseList = require('bearded-route-list')

##Example

// Import the package
import baseList from 'bearded-route-list'

// Create routes/handlers
const UserRoute = express.Router(),
      AuthRoute = express.Router(),
      app = express()

// ...
// add endpoints to route
// ...

const routes = [
  {
    path: '/users',
    handler: UserRoute
  },
  {
    path: '/auth',
    handler: AuthRoute
  }
]

baseList(routes,app) // this will hook into the route '/'

// OR

baseList(routes, app, '/list') // this will hook into route '/list'

And going to '/' will return this:

{
  "/auth": {
    "/login": {
      "methods": {
        "post": true
      }
    }
  },
  "/users": {
    "/": {
      "methods": {
        "get": true,
        "post": true
      }
    },
    "/:_id": {
      "methods": {
        "delete": true,
        "get": true,
        "patch": true
      }
    }
  }
}

##Description

(routes = [], app, base = '/')

With routes being an array of objects with the following syntax:

{
  path: String,
  handler: express.Router()
}

App being an express() instance

base being the route you want the list of endpoints to be at.