Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(techniques/mvc): introduce @WithAlias() decorator #1400

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions content/techniques/mvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,42 @@ In this code, we are specifying the template to use in the `@Render()` decorator

While the application is running, open your browser and navigate to `http://localhost:3000`. You should see the `Hello world!` message.

#### Aliasing Routes

You can alias routes with the `@WithAlias()` decorator in your controller, and then reference the alias inside your view.

Suppose in your user controller, you have some routes to a list of users or to a specific user:
```typescript
@@filename(users.controller)
import { Get, Controller, Render, WithAlias } from '@nestjs/common';
import { User } from './user.entity.ts';

@Controller('users')
export class UserController {
@Get()
@Render('users-list')
@WithAlias('users')
root(): User[] {
return [ /* list of users */ ];
}

@Get('/:user')
@Render('user')
@WithAlias('user')
getUser(): User {
return { /* user */ }
}
}
```
Once you have registered route aliases, you can access them via the `getUrl(routeAlias: string, routeParams?: object): string` method that is injected into the template render context.

```njk
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this njk is making the building fails. Try text instead.

<a href="{{ getUrl('users') }}">Users</a>
<a href="{{ getUrl('user', { user: user.id }) }}">User With Specific ID</a>
```

> warn **Note** Some templating engines (like handlebars) do not support evaluation of functions inside your template.

#### Dynamic template rendering

If the application logic must dynamically decide which template to render, then we should use the `@Res()` decorator, and supply the view name in our route handler, rather than in the `@Render()` decorator:
Expand Down