-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
sjones6
wants to merge
2
commits into
nestjs:master
Choose a base branch
from
sjones6:patch-2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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('hello') | ||
root(): User[] { | ||
return [ /* list of users */ ]; | ||
} | ||
|
||
@Get('/:user') | ||
@Render('user') | ||
@WithAlias('hello') | ||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess this |
||
<a href="{{ getUrl('users-list') }}">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: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these two routes supposed to have the same alias?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jmcdo29 , whoops. Nope. Correcting...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jmcdo29 , should be updated now.