Type Alias IssueCode

Machine-readable reason a value failed validation.

Prefer branching on this over matching the human-readable message, which is formatted for people and is not part of the stable API.

"invalid_type"
The value was present but did not match any of the expected types.
"missing_key"
A required key was absent from the object.
"unknown_type"
The schema referenced a type name that is not registered.
"invalid_schema"
The schema itself is malformed (empty type string, array with 2 entries, …).
"unexpected_key"
Strict mode only: the object carried a key the schema does not declare.
"too_small"
The value was below a lower bound — too short, too few elements, or numerically too small. minimum carries the bound that was violated.
"too_big"
The value was above an upper bound — too long, too many elements, or numerically too large. maximum carries the bound that was violated.
"invalid_format"
The value had the right type but the wrong shape: not an email, not a UUID, not an integer, no match for the given pattern. expected names the format.
"custom"
A Validator function supplied in the schema threw.
"dangerous_key"
An undeclared __proto__, constructor or prototype own key was present and could not be removed, because the object is frozen or the property is non-configurable. On a normal object the key is stripped silently and no issue is reported.