feat(apply-decorators)

[karlos1337]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

A new helper method.

[ ] Bugfix
[X] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #3104

What is the new behavior?

Could use helper method to combine multiple decorators at once.
For example:

// auth.decorator.ts
import { applyDecorators, NestCustomDecorator } from '@nestjs/core';

export function Auth(
  roles: UserRole | UserRole[],
): NestCustomDecorator {
  return applyDecorators(
    SetMetadata('roles', Array.isArray(roles) ? roles : [roles]),
    UseGuards(AuthGuard),
    ApiBearerAuth(),
    ApiUnauthorizedResponse({ description: 'Unauthorized' }),
  );
}

To be used as:

import { Auth } from '../auth/auth.decorator';
[...]
@Get('')
@Auth('admin')
@ApiOkResponse({ type: [User], description: 'Users fetched successfully' })
getUsers() { [...] }

Applying all four decorators at once and encapsulating all auth related ones.

Does this PR introduce a breaking change?

[ ] Yes
[X] No

[coveralls]

Pull Request Test Coverage Report for Build 4215

• 5 of 5 (100.0%) changed or added relevant lines in 2 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.005%) to 95.2%

---

Totals
Change from base Build 3710:	0.005%
Covered Lines:	4363
Relevant Lines:	4583

---

💛 - Coveralls

[kamilmysliwiec]

Instead of using any, can you refactor the code to use MethodDecorator / ClassDecorator type?

[karlos1337]

Done, I've also created an exported type to define the new decorator.

[kamilmysliwiec]

Thank you!

[kamilmysliwiec]

Do you want to create a PR to the docs with this feature?

[karlos1337]

Sure, but my English is so far from perfect, maybe will need a review, I'll refer docs PR here when done.

[kamilmysliwiec]

Sure thing, no worries @karlos1337!

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.