Skip to content

docs(custom-decorators): specify getRequest type #3462

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.

Sign up for GitHub

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

Open
axel7083 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(custom-decorators): specify getRequest type #3462

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions content/custom-decorators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,21 @@ async findOne(user) {
}
```

> info **Hint** For TypeScript users, note that `ctx.switchToHttp().getRequest<T>()` depends on the framework used, for example if you are using express you can specify the appropriate type
>
> ```typescript
> @@filename(user.decorator)
> import { createParamDecorator, ExecutionContext } from '@nestjs/common';
> import type { Request } from 'express';
> export const Page = createParamDecorator(
> (data: never, ctx: ExecutionContext) => {
> const request = ctx.switchToHttp().getRequest<Request>();
> return request.query['page'] ?? 0;
> },
> );
> ```


#### Passing data

When the behavior of your decorator depends on some conditions, you can use the `data` parameter to pass an argument to the decorator's factory function. One use case for this is a custom decorator that extracts properties from the request object by key. Let's assume, for example, that our <a href="techniques/authentication#implementing-passport-strategies">authentication layer</a> validates requests and attaches a user entity to the request object. The user entity for an authenticated request might look like:
Expand Down