Skip to content

Add .exactOptional() #5589

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

Jump to bottom
Merged
colinhacks merged 2 commits into from
Dec 31, 2025
Merged

Add .exactOptional() #5589

colinhacks merged 2 commits into from
Dec 31, 2025

Conversation

@colinhacks
Copy link
Owner

@colinhacks colinhacks commented Dec 31, 2025 •
edited
Loading

Closes #5495 #635 #1510

I don't love this API but it's the best we've got at the moment. This is 100% opt-in. The classic .optional() will continue behaving as it always has.

const A = z.object({
  a: z.string().optional(),
  b: z.string().exactOptional(),
});

type A = z.infer<typeof A>;
// => {
//   a?: string | undefined;
//   b?: string;
// }

A.parse({}); // ✅
A.parse({ a: undefined }); // ✅
A.parse({ b: undefined }); // ❌

Trying to enable exact optionality via some kind of global config is too kludgey and footgunny, so it needed to be an explicit API.

pullfrog[bot]
pullfrog bot reviewed Dec 31, 2025
View reviewed changes
Copy link
Contributor

@pullfrog pullfrog bot left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking issue: the non-JIT code path doesn't implement the same error suppression logic as the JIT path, which will cause test failures and incorrect runtime behavior when jitless mode is enabled.

Pullfrog  ｜ Fix all ➔ ｜ Fix 👍s ➔ ｜ View workflow run ｜ pullfrog.com ｜ 𝕏

Repository owner deleted a comment from pullfrog bot Dec 31, 2025
@colinhacks colinhacks merged commit a7b1d18 into main Dec 31, 2025
12 checks passed
@colinhacks colinhacks deleted the exact-optional branch December 31, 2025 04:25
This was referenced Dec 31, 2025
Closed
Closed
@Fl4wless Fl4wless mentioned this pull request Jan 7, 2026
Closed
@busma13 busma13 mentioned this pull request Jan 21, 2026
Open
@pullfrog pullfrog bot mentioned this pull request Jan 22, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pullfrog pullfrog[bot] pullfrog[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug: Cannot type { key?: string }, can only do { key?: string | undefined }

1 participant

@colinhacks