feat(common): add pipes for multiple files validation #14994
Closed
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
When dealing with file uploads, NestJS offers the
ParseFilePipe
to help validate files uploaded under the same name. But when several files are uploaded with different names, there is not built-in pipe available and the validation is usually done in the controller method or service.Issue Number: N/A
What is the new behavior?
This PR adds two new pipes,
ParseFileFieldsPipe
andGroupFilesPipe
that can be used to validate multiple files together in association with theUploadedFiles
decorator and file interceptors.Here are some examples:
The
ParseFileFieldsPipe
constructor accepts anoptions
object with afields
prop that defines for each uploaded file, the validation options that will passed to theParseFilePipe
object that will be used for validation.It is also possible to validate files extracted with
AnyFilesInterceptor()
by usingGroupFilesPipe
andParseFileFieldsPipe
together:The
GroupFilesPipe
is used to group uploaded files byfieldname
, like theFileFieldsInterceptor
does.Does this PR introduce a breaking change?
Other information
If the PR is accepted, the NestJS doc about file uploads will be updated to integrate the new features.