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

express-route-logging

v1.0.1

Published

A minimal express-route-logger that logs information about different routes, middlewares, method, params and query used in the express web-app

Downloads

4

Readme

Express-route-listing

Express-route-listing is a minimal, lightweight, route logger package to log or write (Or Both) express APIs in a file, which helps in documenting the stuff for newer people who will/are contributing their efforts to your repo.

Express-route-listing currently helps in logging PARAMS , METHODS , MIDDLEWARE AND PATH.

It has option to printToConsole or writeToFile. To Show routes info in console. Or show them into as md table in Route.md ( in the directory where package.json is present )

Example :

Using this package in ES6 module  

import AccquireRoute from "./index.mjs" 
const OPTIONS = { 
	printToConsole : BOOLEAN (default true ), 
	writeToFile : BOOLEAN (default false ) 
} 
AccquireRoute(app , { 
		OPTIONS 
		}) 

Using this package in CommonJs Module ( require dynamic importing )

const modulePath = PATH
const OPTIONS = {
	printToConsole : BOOLEAN, // (default true )
	writeToFile : BOOLEAN // (default false )
}
import(modulePath).then(routeLog => {
	routeLog.AccquireRoute(app , OPTIONS)
		})
		

Test Case Example

app.route('/')
    .get((req, res) => {
            res.end()
    })
    .all((req, res) => {
            res.end()
    })
    .post((req, res) => {
            res.end()
    })

app.route('/testing')
    	.all((req, res) => {
            res.end()
    	})
    	.delete((req, res) => {
            	res.end()
    	})
app.route('/testing')
    	.all((req, res) => {
            	res.end()
    	})
    	.delete((req, res) => {
            	res.end()
        })

router.route('/')
    	.get((req, res) => {
            	res.end()
    	})
    	.all((req, res) => {
            	res.end()
    	})
    	.post((req, res) => {
            	res.end()
    	})

function mid(req, res, next ){
    next()
}

function mid1(req, res, next)
{
    	next()
}

function mid2(req,res ,next)
{
    	next()
}
app.get('/testing1/:id?something ', mid , mid1 , mid2 , (req,res,next)=>{
    	console.log("this is a working example for query and params")
})
Output in console
[
 {
    path: '/',
    middleware: [],
    methods: [ 'GET', '_ALL', 'POST' ],
    params: [],
    query: []
  },
  {
    path: '/testing',
    middleware: [],
    methods: [ '_ALL', 'DELETE' ],
    params: [],
    query: []
  },
  {
    path: '/testing',
    middleware: [],
    methods: [ '_ALL', 'DELETE' ],
    params: [],
    query: []
  },
  {
    path: '/testing1/:id?somthing ',
    middleware: [ { name: 'mid' }, { name: 'mid1' }, { name: 'mid2' } ],
    methods: [ 'GET' ],
    params: [ { name: 'id' } ],
    query: [ { name: 'somthing ' } ]
  }
]
Output in Route.md

| path | methods | middleware | params | query | | ----------------------- | ------- | ---------- | ------ | --------- | | / | | | | | | | GET | | | | | | _ALL | | | | | | POST | | | | | /testing | | | | | | | _ALL | | | | | | DELETE | | | | | /testing | | | | | | | _ALL | | | | | | DELETE | | | | | /testing1/:id?somthing | | | | | | | GET | mid | id | somthing | | | | mid1 | | | | | | mid2 | | |