feat: strict branding with opt-out #3380
Closed
Conversation
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
✅ Deploy Preview for guileless-rolypoly-866f8a ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
KATT
commented
Apr 4, 2024
| B extends string | number | symbol | ||
| > extends ZodType<T["_output"] & BRAND<B>, ZodBrandedDef<T>, T["_input"]> { | ||
| B extends string | number | symbol, | ||
| S extends boolean |
There was a problem hiding this comment.
this could be
Suggested change
| S extends boolean | |
| S extends boolean = false |
if we don't want breaking changes
| @@ -466,8 +466,16 @@ export abstract class ZodType< | |||
| }) as any; | |||
| } | |||
|
|
|||
| brand<B extends string | number | symbol>(brand?: B): ZodBranded<this, B>; | |||
| brand<B extends string | number | symbol>(): ZodBranded<this, B> { | |||
| brand<B extends string | number | symbol, S extends boolean = true>( | |||
There was a problem hiding this comment.
non-breaking:
Suggested change
| brand<B extends string | number | symbol, S extends boolean = true>( | |
| brand<B extends string | number | symbol, S extends boolean = false>( |
| ): ZodBranded<this, B, S>; | ||
| brand< | ||
| B extends string | number | symbol, | ||
| S extends boolean = true |
There was a problem hiding this comment.
non-breaking
Suggested change
| S extends boolean = true | |
| S extends boolean = false |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
when branding, it's useful to retain the branding on
_inputso you have to explicitly pass a branded value when using the schemathis reverts #1492 but with the option of opting out of branded behavior
I can make it a non-breaking change if that's preferred, so it default to non-strict mode
cc @Xetera