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.

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

chore(common): Add type declaration for RawBody decorator with pipes #14256

Merged
merged 2 commits into from
Dec 3, 2024
Merged

chore(common): Add type declaration for RawBody decorator with pipes #14256

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
439231e
chore(common): Add type declaration for RawBody decorator with pipes
sapenlei Dec 3, 2024
59bf615
refactor(common): Add type declaration for RawBody decorator with pipes
sapenlei Dec 3, 2024
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
16 changes: 0 additions & 16 deletions packages/common/decorators/http/route-params.decorator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,22 +508,6 @@ export function Body(
);
}

/**
* Route handler parameter decorator. Extracts the `rawBody` Buffer
* property from the `req` object and populates the decorated parameter with that value.
*
* For example:
* ```typescript
* async create(@RawBody() rawBody: Buffer | undefined)
* ```
*
* @see [Request object](https://docs.nestjs.com/controllers#request-object)
* @see [Raw body](https://docs.nestjs.com/faq/raw-body)
*
* @publicApi
*/
export function RawBody(): ParameterDecorator;
Copy link
Member

Choose a reason for hiding this comment

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

This is an overloaded method signature. Instead of removing it, we should just add one for the variant with pipes, right below this line

Copy link
Contributor Author

@sapenlei sapenlei Dec 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The type declaration for RawBody(...args) already supports the empty parameter case RawBody(), so you can safely remove the separate empty parameter declaration.

the type declaration for RawBody(...args) already supports the empty parameter case RawBody(), so you can safely remove the separate empty parameter declaration.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

CleanShot 2024-12-03 at 16 58 17@2x

@kamilmysliwiec

Copy link
Member

Choose a reason for hiding this comment

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

This is just for better DX - we do it all around the ecosystem


/**
* Route handler parameter decorator. Extracts the `rawBody` Buffer
* property from the `req` object and populates the decorated parameter with that value.
Expand Down
Loading