Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nestjsx/nest-router
Router Module For Nestjs Framework 🚦 🚀
https://github.com/nestjsx/nest-router
addons nestjs typescript utilities
Last synced: 3 days ago
JSON representation
Router Module For Nestjs Framework 🚦 🚀
- Host: GitHub
- URL: https://github.com/nestjsx/nest-router
- Owner: nestjsx
- License: mit
- Created: 2018-01-31T19:49:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T00:16:23.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T02:12:26.748Z (10 days ago)
- Topics: addons, nestjs, typescript, utilities
- Language: TypeScript
- Size: 2.15 MB
- Stars: 618
- Watchers: 9
- Forks: 36
- Open Issues: 104
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Nest Router :vertical_traffic_light:
[](https://greenkeeper.io/) [](https://travis-ci.org/shekohex/nest-router) [](Https://www.npmjs.com/package/nest-router) [](https://coveralls.io/github/shekohex/nest-router?branch=master)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fshekohex%2Fnest-router?ref=badge_shield)
Router Module For [Nestjs](https://github.com/nestjs/nest) Framework
## Important Note
As of Nestjs `v8.0.0` This module got added into the `@nestjs/core`.
see the [docs](https://docs.nestjs.com/recipes/router-module)
with that being said, this package is still maintained (for now).
## Quick Overview
`RouterModule` helps you organize your routes and lets you create a routes tree.
### How ?
Every module could have a path property. That path will be a prefix for all controllers in this module. If that module has a parent, it will be a child of it and again all controllers in this child module will be prefixed by `parent module prefix` + `this module prefix`
> see issue [#255](https://github.com/nestjs/nest/issues/255) .
## Install
IMPORTANT: you need Nest > v4.5.10+
```bash
npm install nest-router --save
```
OR
```bash
yarn add nest-router
```
## Setup
See how easy it is to set up.
```ts
... //imports
const routes: Routes = [
{
path: '/ninja',
module: NinjaModule,
children: [
{
path: '/cats',
module: CatsModule,
},
{
path: '/dogs',
module: DogsModule,
},
],
},
];
@Module({
imports: [
RouterModule.forRoutes(routes), // setup the routes
CatsModule,
DogsModule,
NinjaModule
], // as usual, nothing new
})
export class ApplicationModule {}
```
> :+1: TIP: Keep all of your routes in a separate file like `routes.ts`
In this example, all the controllers in `NinjaModule` will be prefixed by `/ninja` and it
has two childs, `CatsModule` and `DogsModule`.
Will the controllers of `CatsModule` be prefixed by `/cats`? NO!! :open_mouth:
The `CatsModule` is a child of `NinjaModule` so it will be prefixed by `/ninja/cats/` instead.
And so will `DogsModule`.
> See examples folder for more information.
#### Example Folder Project Structure
```bash
.
├── app.module.ts
├── cats
│  ├── cats.controller.ts
│  ├── cats.module.ts
│  └── ketty.controller.ts
├── dogs
│  ├── dogs.controller.ts
│  ├── dogs.module.ts
│  └── puppy.controller.ts
├── main.ts
└── ninja
├── katana.controller.ts
├── ninja.controller.ts
└── ninja.module.ts
```
And here is a simple, nice route tree of `example` folder:
```bash
ninja
├── /
├── /katana
├── cats
│  ├── /
│  └── /ketty
├── dogs
  ├── /
  └── /puppy
```
Nice!
#### Params in nested routes
In a standard REST API, you probably would need to add some params to your nested routes. Here is an example of how you can achieve it:
```ts
... //imports
const routes: Routes = [
{
path: '/ninja',
module: NinjaModule,
children: [
{
path: '/:ninjaId/cats',
module: CatsModule,
},
{
path: '/:ninjaId/dogs',
module: DogsModule,
},
],
},
];
```
The `ninjaId` param will be available inside `CatsModule` controllers and `DogsModule` controllers. Please, find the [instruction how to handle params in the official documentation](https://docs.nestjs.com/controllers#route-parameters). It might be a good practice to use a [pipe for transformation use case](https://docs.nestjs.com/pipes#transformation-use-case) to have an access to `ninja` object instead of just id.
#### Resolve Full Controller Path:
Nestjs dosen't resolve or take into account `MODULE_PATH` metadata when it is coming to resolve Controller path in Middleware resolver for example, so that i introduced a new fancy method `RouterModule#resolvePath` that will resolve the full path of any controller so instead of doing so:
```ts
consumer.apply(someMiddleware).forRoutes(SomeController);
```
you should do
```ts
consumer.apply(someMiddleware).forRoutes(RouterModule.resolvePath(SomeController));
```
see [#32](https://github.com/shekohex/nest-router/pull/32) for more information about this.
## CHANGELOG
See [CHANGELOG](CHANGELOG.md) for more information.
## Contributing
You are welcome to contribute to this project, just open a PR.
## Authors
* **Shady Khalifa** - _Initial work_
See also the list of [contributors](https://github.com/shekohex/nest-router/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fshekohex%2Fnest-router?ref=badge_large)