nest-list-routes v1.0.3

nest-list-routes

Description

List all routes and additional information for Nest framework.

Installation

$ npm i --save nest-list-routes

Setup

Basic configuration

@Module({
    imports: [
        NestListRoutesModule.forRoot()
    ],
})
export class AppModule {}

That's all. When you start Nest, you will see the following output in the terminal:

List routes with metadata

Support printing the metadata of custom decorators.

For example, assume you have defined a custom decorator named Role, you can configure it like this:

@Module({
    imports: [
        NestListRoutesModule.forRoot({
            metadataKeys: ['Role'],
        })
    ],
})
export class AppModule {}

You will see the following output:

Configuration options

Contributing

You are welcome to contribute to this project, just open a PR.

License

Apache-2.0