Proposal: ZodObject.omitIfExists() #2144
Conversation
I found myself wanting to predefine a set of keys that would always
be omitted from certain schemas if present. Example scenario:
```
const OMIT_AUTOGENERATED = {
id: true,
uuid: true,
createdAt: true,
updatedAt: true
}
const someSchema = someSchemaRaw.omit(OMIT_AUTOGENERATED);
const someSchema2 = someSchema2Raw.omit(OMIT_AUTOGENERATED);
```
If there are certain "Raw schemas" (using the above nomenclature)
that don't have all the properties defined in OMIT_AUTOGENERATED,
then I can't use it on them.
With something like ZodType.omitIfExists() one could blanket-exclude
a set of keys from schemas without necessarily requiring them to
be present in all of them.
✅ Deploy Preview for guileless-rolypoly-866f8a ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hm this is a decent argument for reverting the behavior introduced in #1564. I think I'm in favor of reverting, esp. since TypeScript itself doesn't care: type asdf = Omit<{ a: string }, "b">;
// no errorI'm opposed to adding a new method with subtly different behavior, so it comes down to deciding how we want |
|
Let's revert it on all mask methods. It hurts compiler performance. |
|
I let this stew overnight in my head and I also think it's not great to have two subtly different method names. This is a small convenience thing for me so I don't feel strongly about reverting to |
|
I've reverted #1564 in the latest patch release, so this should now work @jussisaurio |
I found myself wanting to predefine a set of keys that would always be omitted from certain schemas if present. Example scenario:
If there are certain "Raw schemas" (using the above nomenclature) that don't have all the properties defined in OMIT_AUTOGENERATED, then I can't use it on them.
With something like ZodType.omitIfExists() one could blanket-exclude a set of keys from schemas without necessarily requiring them to be present in all of them.