Code Monkey home page Code Monkey logo

get-routes's Introduction

get-routes

get-routes gets all routes from an Express application.

Status

Category Status
Version npm
Dependencies David
Dev dependencies David
Build GitHub Actions
License GitHub

Installation

$ npm install get-routes

Quick start

First you need to add a reference to get-routes to your application:

const { getRoutes } = require('get-routes');

If you use TypeScript, use the following code instead:

import { getRoutes } from 'get-routes';

Then, call the getRoutes function with an Express app to get a list of all registered routes:

const routes = getRoutes(app);

console.log(routes);
// => {
//      get: [
//        '/articles'
//      ],
//      post: [
//        '/articles/:id'
//      ],
//      ...
//    }

Running quality assurance

To run quality assurance for this module use roboter:

$ npx roboter

get-routes's People

Contributors

aghabeiki avatar botre avatar dependabot-preview[bot] avatar dependabot[bot] avatar goloroden avatar grundhoeferj avatar halkeye avatar semantic-release-bot avatar yeldirium avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

get-routes's Issues

Fails to find routes when using Router

var express = require("express");
var Router = express.Router;

var app = express();
var router = new Router();
router.get("/test", (req, res) => { res.send(); });

app.use(router);
// ---------
var getRoutes = require("get-routes");
console.log(routes); // empty

It reads that middleware.route is empty, but doesn't check to see if middleware.handler is of type Router.

New release

Would it be possible to cut a new release for this package? I would like to use the updated dependencies due to some security issues with the version of lodash that is being used in the currently published version.

Thanks!

Does this even work?

I don't know if this still works. To do something similar I had to use the following code

    const getRouter = () => {
      return app._router
    }

    getRouter().stack.forEach(function (r) {
      if (r.handle.stack)
        r.handle.stack.forEach((item) => {
          if (item.route)
            console.log(item.route.methods,item.route.path)
        })
    })

Which is completely different from your code? I am running "express": "^4.16.2"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.