List All Routes in express app (v5)

[ex1st]

In continue of this discussion #5858

After upgrade to stable v5 i can't find layer.regexp anymore. So, prevoius soluton doesn't work anymore.
Does anyone have any ideas on how to build a complete tree of subrouts? Thank you!

[IamLizu]

If pillarjs/router#122 is agreed upon, then the following function will solve this case.

 * Recursively prints the registered routes of an Express router.
 *
 * @param {Array} routerStack - The stack of middleware and routes from an Express router.
 * @param {string} [parentPath=''] - The parent path to prepend to the route paths.
 */
function printRegisteredRoutes(routerStack, parentPath = '') {
    routerStack.forEach((middleware) => {
        if (middleware.route) {
            console.debug(
                middleware.route.stack[0].method.toUpperCase(),
                `${parentPath}${middleware.route.path}`
            );
        } else if (middleware.name === 'router') {
            printRegisteredRoutes(
                middleware.handle.stack,
                `${parentPath}${middleware.path}`
            );
        }
    });
}

[ejmartin504]

Hopefully this is the right place to ask this.. The function you reference takes a router stack as a param, but how does one access the router stack in express v5? Our app uses app._router.stack to list all routes, but _router does not seem to be defined in express v5. Thank you!

[anthwal]

@ejmartin504 I was trying to do the same and now the _router property is changed to router which is a getter. And it worked.

[ejmartin504]

Ah excellent! Now I'm hitting the same issue reported by @ex1st -- we were using the regexp property on layer, but it's no longer there :-/ I'll stay tuned here and hope the upstream PR is merged

[wesleytodd]

FWIW, it looks like this change in v5 is the most depended on and not easily resolved issue we have had reported. I should have better anticipated it as even I have a package which depends on this internal api, but it was a deep enough I thought we would have limited impact. It is probably a good sign that this is the top issue folks are hitting in the migration 😆.

Anyway, I am catching up on issues now, but I think I will bring this up as our next highest priority issue. Thanks for the input, and I will be sure to loop back here as soon as I have gathered reports into one place (over in the router repo).