Optional
def: $ZodObjectDef<Shape>Optional
params: { parent: boolean }Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Returns a new instance that has been registered in z.globalRegistry
with the specified description
Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Use A.extend(B.shape)
instead.
Returns the metadata associated with this instance in z.globalRegistry
Returns a new instance that has been registered in z.globalRegistry
with the specified metadata
Optional
params: Optional
error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>Optional
message?: stringOptional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
params: Optional
abort?: booleanIf true, no later checks will be executed if this check fails. Default false
.
Optional
error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>Optional
message?: stringOptional
params?: Record<string, any>Optional
path?: PropertyKey[]Optional
when?: (payload: ParsePayload) => booleanIf provided, this check will only be executed if the function returns true
. Defaults to payload => z.util.isAborted(payload)
.
Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
params: ParseContext<$ZodIssue>Optional
description
Define a schema to validate all unrecognized keys. This overrides the existing strict/loose behavior.