Class GroupConditional<Properties, Input, Output, CamelCaseOutput>

GroupConditional represents a subset of object properties that are conditionally validated and merged based on a runtime condition. This allows schemas to have different required fields depending on the values in the object being validated.

Example

vine.group.if(
  (value) => value.shipping_required === true,
  {
    shipping_address: vine.string(),
    shipping_method: vine.string()
  }
)

Type Parameters

Properties extends Record<string, SchemaTypes>
Record of property names to their schema types
Input
Expected input type for these properties
Output
Output type after validation and transformation
CamelCaseOutput
Output type with camelCase property names

Implements

WithJSONSchema

Index

Constructors

constructor

new GroupConditional<
    Properties extends Record<string, SchemaTypes>,
    Input,
    Output,
    CamelCaseOutput,
>(
    conditional: ConditionalFn<Record<string, unknown>>,
    properties: Properties,
): GroupConditional<Properties, Input, Output, CamelCaseOutput>
Creates a new GroupConditional with a condition and properties.
Type Parameters
- Properties extends Record<string, SchemaTypes>
  Record of property names to their schema types
- Input
  Expected input type for these properties
- Output
  Output type after validation and transformation
- CamelCaseOutput
  Output type with camelCase property names
Parameters
- conditional: ConditionalFn<Record<string, unknown>>
  Function that returns truthy value when properties should be validated
- properties: Properties
  Properties to validate and merge when condition is true
Returns GroupConditional<Properties, Input, Output, CamelCaseOutput>
- Defined in src/schema/object/conditional.ts:61

Properties

[ITYPE]

"[ITYPE]": Input

[OTYPE]

"[OTYPE]": Output

[COTYPE]

"[COTYPE]": CamelCaseOutput

Methods

toJSONSchema

toJSONSchema(): JSONSchema7
Converts the conditional properties to JSON Schema format.

Returns JSONSchema7
JSON Schema representation of this conditional's properties
Implementation of WithJSONSchema.toJSONSchema
- Defined in src/schema/object/conditional.ts:71

[PARSE]

"[PARSE]"(refs: RefsStore, options: ParserOptions): {}
Compiles the conditional to a compiler node for validation.
Parameters
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options
Returns {}
Compiled conditional node
- Defined in src/schema/object/conditional.ts:98

Class GroupConditional<Properties, Input, Output, CamelCaseOutput>

Example

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GroupConditional<Properties, Input, Output, CamelCaseOutput>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Methods

toJSONSchema

Returns JSONSchema7

[PARSE]

Parameters

Returns {}

Settings

On This Page