Skip to content

feat(docs): add errorFormat option to ValidationPipe documentation #3386

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

Merged
kamilmysliwiec merged 1 commit into from
Apr 14, 2026
+6 −0
Merged

feat(docs): add errorFormat option to ValidationPipe documentation #3386

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
6 changes: 6 additions & 0 deletions content/techniques/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface ValidationPipeOptions extends ValidatorOptions {
transform?: boolean;
disableErrorMessages?: boolean;
exceptionFactory?: (errors: ValidationError[]) => any;
errorFormat?: 'list' | 'grouped';
}
```

Expand Down Expand Up @@ -129,6 +130,11 @@ In addition to these, all `class-validator` options (inherited from the `Validat
<td><code>boolean</code></td>
<td>When set to true, validation of the given property will stop after encountering the first error. Defaults to false.</td>
</tr>
<tr>
<td><code>errorFormat</code></td>
<td><code>'list' | 'grouped'</code></td>
<td>Specifies the format of validation error messages. <code>'list'</code> (default) returns an array of error message strings. <code>'grouped'</code> returns an object with property paths as keys and arrays of unmodified error messages as values, preserving custom validation messages without prepending parent path prefixes.</td>
</tr>
</table>

> info **Notice** Find more information about the `class-validator` package in its [repository](https://github.com/typestack/class-validator).
Expand Down