Skip to content

Commit

Permalink
chore: version packages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored and jmike committed Jan 16, 2024
1 parent d42a422 commit bfc7eaa
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 40 deletions.
39 changes: 0 additions & 39 deletions .changeset/popular-suns-knock.md

This file was deleted.

40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# @causaly/zod-validation-error

## 3.0.0

### Major Changes

- deb4639: 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.

## 2.1.0

### Minor Changes
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "zod-validation-error",
"version": "2.1.0",
"version": "3.0.0",
"description": "Wrap zod validation errors in user-friendly readable messages",
"keywords": [
"zod",
Expand Down

0 comments on commit bfc7eaa

Please sign in to comment.