Skip to content

Releases: colinhacks/zod

v3.22.4

04 Oct 21:53
@github-actions github-actions
v3.22.4
e7a9b9b
Compare
Choose a tag to compare
v3.22.4

Commits:

Assets 2
Loading

v3.22.3

03 Oct 18:34
@github-actions github-actions
v3.22.3
1e61d76
Compare
Choose a tag to compare
v3.22.3

Commits:

Assets 2
Loading

v3.22.2

19 Aug 00:15
@github-actions github-actions
v3.22.2
792b3ef
Compare
Choose a tag to compare
v3.22.2

Commits:

Assets 2
Loading

v3.22.1

15 Aug 19:43
@github-actions github-actions
v3.22.1
0a055e7
Compare
Choose a tag to compare
v3.22.1

Commits:

Fix handing of this in ZodFunction schemas. The parse logic for function schemas now requires the Reflect API.

const methodObject = z.object({
  property: z.number(),
  method: z.function().args(z.string()).returns(z.number()),
});
const methodInstance = {
  property: 3,
  method: function (s: string) {
    return s.length + this.property;
  },
};
const parsed = methodObject.parse(methodInstance);
parsed.method("length=8"); // => 11 (8 length + 3 property)
Assets 2
Loading

v3.22.0

14 Aug 19:24
@github-actions github-actions
v3.22.0
fba438c
Compare
Choose a tag to compare
v3.22.0

ZodReadonly

This release introduces ZodReadonly and the .readonly() method on ZodType.

Calling .readonly() on any schema returns a ZodReadonly instance that wraps the original schema. The new schema parses all inputs using the original schema, then calls Object.freeze() on the result. The inferred type is also marked as readonly.

const schema = z.object({ name: string }).readonly();
type schema = z.infer<typeof schema>;
// Readonly<{name: string}>

const result = schema.parse({ name: "fido" });
result.name = "simba"; // error

The inferred type uses TypeScript's built-in readonly types when relevant.

z.array(z.string()).readonly();
// readonly string[]

z.tuple([z.string(), z.number()]).readonly();
// readonly [string, number]

z.map(z.string(), z.date()).readonly();
// ReadonlyMap<string, Date>

z.set(z.string()).readonly();
// ReadonlySet<Promise<string>>

Commits:

Assets 2
Loading

v3.21.4

07 Mar 04:39
@github-actions github-actions
v3.21.4
22f3cc6
Compare
Choose a tag to compare
v3.21.4

Commits:

Assets 2
Loading

v3.21.3

06 Mar 21:48
@github-actions github-actions
v3.21.3
2db0dca
Compare
Choose a tag to compare
v3.21.3

Commits:

Assets 2
Loading

v3.21.2

06 Mar 07:20
@github-actions github-actions
v3.21.2
ac0135e
Compare
Choose a tag to compare
v3.21.2

Commits:

  • b276d71 Improve typings in generics
  • 4d016b7 Improve type inference in generics
  • f9895ab Improve types inside generic functions
  • ac0135e Pass input into catchValue
Assets 2
Loading

v3.21.1

06 Mar 02:52
@github-actions github-actions
v3.21.1
942e2db
Compare
Choose a tag to compare
v3.21.1

Features

Support for ULID validation

z.string().ulid();

Commits:

Assets 2
Loading

v3.21.0

04 Mar 10:33
@github-actions github-actions
v3.21.0
0aa6021
Compare
Choose a tag to compare
v3.21.0

Features

z.string().emoji()

Thanks @joseph-lozano for #2045! To validate that all characters in a string are emoji:

z.string().emoji()

...if that's something you want to do for some reason.

z.string().cuid2()

Thanks @joulev for #1813! To validate CUIDv2:

z.string().cuid2()

z.string().ip()

Thanks @fvckDesa for #2066. To validate that a string is a valid IP address:

const v4IP = "122.122.122.122";
const v6IP = "6097:adfa:6f0b:220d:db08:5021:6191:7990";

// matches both IPv4 and IPv6 by default
const ipSchema = z.string().ip();
ipSchema.parse(v4IP) //  pass
ipSchema.parse(v6IP) //  pass

To specify a particular version:

const ipv4Schema = z.string().ip({ version: "v4" });
const ipv6Schema = z.string().ip({ version: "v6" });

z.bigint().{gt|gte|lt|lte}()

Thanks @igalklebanov for #1711! ZodBigInt gets the same set of methods found on ZodNumber:

z.bigint().gt(BigInt(5));
z.bigint().gte(BigInt(5));
z.bigint().lt(BigInt(5));
z.bigint().lte(BigInt(5));
z.bigint().positive();
z.bigint().negative();
z.bigint().nonnegative();
z.bigint().nonpositive();
z.bigint().multipleOf(BigInt(5));

z.enum(...).extract() and z.enum(...).exclude()

Thanks @santosmarco-caribou for #1652! To add or remove elements from a ZodEnum:

const FoodEnum = z.enum(["Pasta", "Pizza", "Tacos", "Burgers", "Salad"]);
const ItalianEnum = FoodEnum.extract(["Pasta", "Pizza"]); // ZodEnum<["Pasta", "Pizza"]>
const UnhealthyEnum = FoodEnum.exclude(["Salad"]); // ZodEnum<["Pasta", "Pizza", "Tacos", "Burgers"]>

This API is inspired by the Exclude and Extract TypeScript built-ins.

Pass a function to .catch()

Thanks @0xWryth for #2087! The .catch() method now accepts a function that receives the caught error:

const numberWithErrorCatch = z.number().catch((ctx) => {
  ctx.error; // ZodError
  return 42;
});

Compiler performance

Zod 3.20.2 introduced an accidental type recursion that caused long compilation times for some users. These kinds of bugs are very hard to diagnose. Big shoutout to @gydroperit for some heroic efforts here: #2107 Zod 3.21 resolves these issues:

Commits:

Contributors

0xWryth, gydroperit, and 5 other contributors
Assets 2
Loading