-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
'zod-validation-error': major | ||
--- | ||
|
||
BREAKING CHANGE: Refactor `ValidationError` to accept `ErrorOptions` as second parameter. | ||
|
||
What changed? | ||
|
||
Previously, `ValidationError` accepted `Array<ZodIssue>` as 2nd parameter. Now, it accepts `ErrorOptions` which contains a `cause` property. If `cause` is a `ZodError` then it will extract the attached issues and expose them over `error.details`. | ||
|
||
Why? | ||
|
||
This change allows us to use `ValidationError` like a native JavaScript [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/Error). For example, we can now do: | ||
|
||
```typescript | ||
import { ValidationError } from 'zod-validation-error'; | ||
|
||
try { | ||
// attempt to do something that might throw an error | ||
} catch (err) { | ||
throw new ValidationError('Something went deeply wrong', { cause: err }); | ||
} | ||
``` | ||
|
||
How can you update your code? | ||
|
||
If you are using `ValidationError` directly, then you need to update your code to pass `ErrorOptions` as a 2nd parameter. | ||
|
||
```typescript | ||
import { ValidationError } from 'zod-validation-error'; | ||
|
||
// before | ||
const err = new ValidationError('Something went wrong', zodError.issues); | ||
|
||
// after | ||
const err = new ValidationError('Something went wrong', { cause: zodError }); | ||
``` | ||
|
||
If you were never using `ValidationError` directly, then you don't need to do anything. |