Class: VFunction<Type, IsOptional>
For AI agents: see llms.txt for the complete documentation index. Markdown versions are available by adding .md to a page URL or requesting Accept: text/markdown.
values.VFunction
The type of the v.function() validator.
Type parameters
| Name | Type |
|---|---|
Type | FunctionHandle_future<any> |
IsOptional | extends OptionalProperty = "required" |
Hierarchy
-
BaseValidator<Type,IsOptional>↳
VFunction
Constructors
constructor
• new VFunction<Type, IsOptional>(«destructured»)
Type parameters
| Name | Type |
|---|---|
Type | FunctionHandle_future<any> |
IsOptional | extends OptionalProperty = "required" |
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› isOptional | IsOptional |
› fnType? | FunctionType |
› args? | GenericValidator |
› returns? | GenericValidator |
Overrides
BaseValidator<Type, IsOptional>.constructor
Defined in
Properties
type
• Readonly type: Type
Only for TypeScript, the TS type of the JS values validated by this validator.
Inherited from
BaseValidator.type
Defined in
fieldPaths
• Readonly fieldPaths: never
Only for TypeScript, if this an Object validator, then this is the TS type of its property names.
Inherited from
BaseValidator.fieldPaths
Defined in
isOptional
• Readonly isOptional: IsOptional
Whether this is an optional Object property value validator.
Inherited from
BaseValidator.isOptional
Defined in
isConvexValidator
• Readonly isConvexValidator: true
Always "true".
Inherited from
BaseValidator.isConvexValidator
Defined in
kind
• Readonly kind: "function"
The kind of validator, "function".
Defined in
fnType
• Readonly fnType: undefined | FunctionType
The type of function the handle names, if one was given. This is only enforced during typechecking and will not be validated at runtime.
Defined in
args
• Readonly args: undefined | GenericValidator
The validator for the function's arguments, if one was given. This is only enforced during typechecking and will not be validated at runtime.
Defined in
returns
• Readonly returns: undefined | GenericValidator
The validator for the function's return value, if one was given. This is only enforced during typechecking and will not be validated at runtime.
Defined in
Methods
optional
▸ optional(): VFunction<undefined | Type, "optional">
Allow this validated field to be absent.
Returns
VFunction<undefined | Type, "optional">
Overrides
BaseValidator.optional