getDefault

Returns the default value of the schema.

const value = getDefault<TSchema>(schema, dataset, config);

Generics

Parameters

  • schema TSchema
  • dataset Dataset<null | undefined, never> | undefined
  • config Config<InferIssue<TSchema>> | undefined

Returns

Examples

The following examples show how getDefault can be used.

Optional string schema

Get the default value of an optional string schema.

const OptionalStringSchema = v.optional(v.string(), "I'm the default!");
const defaultValue = v.getDefault(OptionalStringSchema); // "I'm the default!"

The following APIs can be combined with getDefault.

Schemas

Methods

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz