nonOptional

Creates a non optional schema.

This schema function can be used to override the behavior of optional.

const Schema = nonOptional<TWrapped, TMessage>(wrapped, message);

Generics

Parameters

  • wrapped TWrapped
  • message TMessage

Explanation

With nonOptional the validation of your schema will not pass undefined inputs. If the input is undefined, you can use message to customize the error message.

Returns

Examples

The following examples show how nonOptional can be used.

Non optional string

Schema that does not accept undefined.

const NonOptionalStringSchema = v.nonOptional(v.optional(v.string()));

Unwrap non optional

Use unwrap to undo the effect of nonOptional.

const NonOptionalNumberSchema = v.nonOptional(v.optional(v.number()));
const OptionalNumberSchema = v.unwrap(NonOptionalNumberSchema);

The following APIs can be combined with nonOptional.

Schemas

Methods

Actions

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