function

Creates a function schema.

const Schema = v.function<TMessage>(message);

Generics

• TMessage extends ErrorMessage<FunctionIssue> | undefined

Parameters

• message TMessage

Explanation

With function you can validate the data type of the input. If the input is not a function, you can use message to customize the error message.

Returns

• Schema FunctionSchema<TMessage>

Related

The following APIs can be combined with function.

Schemas

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Methods

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Actions

check, brand, description, flavor, guard, metadata, rawCheck, rawTransform, readonly, title, transform

Utils

entriesFromList, isOfKind, isOfType