Skip to main content

default_()

default_<Inner>(schema, defaultValue, message?): DefaultSchema<Inner>

Default schema - provides a default value if undefined.

Type Parameters​

Inner: Inner extends GenericSchema​

Parameters​

schema: Inner​

Base schema.

defaultValue: Infer<Inner> | () => Infer<Inner>​

Default value or function that returns the default value.

message?: string​

Custom error message.

Returns: DefaultSchema<Inner>​

Schema that uses the default value if undefined.

Since​

2.0.0