nullish

Creates a nullish schema.

const Schema = v.nullish<TWrapped, TDefault>(wrapped, default_);

Generics

Parameters

  • wrapped TWrapped
  • default_ TDefault

Explanation

With nullish the validation of your schema will pass undefined and null inputs, and if you specify a default_ input value, the schema will use it if the input is undefined or null. For this reason, the output type may differ from the input type of the schema.

Note that nullish accepts undefined and null as an input. If you want to accept only null inputs, use nullable, and if you want to accept only undefined inputs, use optional instead. Also, if you want to set a default output value for any invalid input, you should use fallback instead.

Returns

Examples

The following examples show how nullish can be used.

Nullish string schema

Schema that accepts string, undefined and null.

const NullishStringSchema = v.nullish(v.string(), "I'm the default!");

Nullish date schema

Schema that accepts Date, undefined and null.

By using a function as the default_ parameter, the schema will return a new Date instance each time the input is undefined or null.

const NullishDateSchema = v.nullish(v.date(), () => new Date());

Nullish entry schema

Object schema with a nullish entry.

const NullishEntrySchema = v.object({
  key: v.nullish(v.string()),
});

Unwrap nullish schema

Use unwrap to undo the effect of nullish.

const NullishNumberSchema = v.nullish(v.number());
const NumberSchema = v.unwrap(NullishNumberSchema);

The following APIs can be combined with nullish.

Schemas

Methods

Actions

Utils

Contributors

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

  • GitHub profile picture of fabian-hiller
  • GitHub profile picture of sqmasep

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 antfu
  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of jdgamble555
  • GitHub profile picture of nickytonline
  • GitHub profile picture of KubaJastrz
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of luckasnix
  • GitHub profile picture of andrew-3kb
  • GitHub profile picture of dslatkin