Class OptionalModifier<Schema>

Modifies a literal schema type to allow undefined values in addition to the original type. This modifier is used for form fields that may not be present in submitted data.

Example

const schema = vine.string().optional()
// Accepts: "hello", undefined
// Rejects: null (unless also nullable), 123

Type Parameters

Schema extends ConstructableLiteralSchema<any, any, any>
The underlying literal schema type to make optional

Hierarchy (View Summary)

ConditionalValidations
- OptionalModifier

Implements

ConstructableLiteralSchema<
    Schema[typeof ITYPE]
    | undefined
    | null,
    Schema[typeof OTYPE] | undefined,
    Schema[typeof COTYPE] | undefined,
>
WithCustomRules

Index

Constructors

constructor

new OptionalModifier<Schema extends ConstructableLiteralSchema<any, any, any>>(
parent: Schema,
validations?: Validation<any>[],
): OptionalModifier<Schema>
Creates a new optional modifier wrapping the given schema.
Type Parameters
- Schema extends ConstructableLiteralSchema<any, any, any>
  The underlying literal schema type to make optional
Parameters
- parent: Schema
  The schema to make optional
- Optionalvalidations: Validation<any>[]
  Optional list of validations to apply
Returns OptionalModifier<Schema>
Overrides ConditionalValidations.constructor
- Defined in src/schema/base/literal.ts:310

Properties

isOptional

isOptional: boolean = true

[ITYPE]

"[ITYPE]": Schema[typeof ITYPE] | null | undefined

Define the input type of the schema, including undefined and null

[OTYPE]

"[OTYPE]": Schema[typeof OTYPE] | undefined

The output value of the field with undefined support. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": Schema[typeof COTYPE] | undefined

Camelcase output type with undefined support

validations

validations: Validation<any>[]

List of additional validations to apply to non-undefined values

Accessors

allowNull

get allowNull(): boolean | undefined
Returns boolean | undefined
Implementation of ConstructableLiteralSchema.allowNull
- Defined in src/schema/base/literal.ts:279

Methods

requiredWhen

requiredWhen<Operator extends ComparisonOperators>(
    otherField: string,
    operator: Operator,
    expectedValue: Operator extends ArrayComparisonOperators
        ? (string | number | boolean)[]
        : Operator extends NumericComparisonOperators
            ? number
            : string
            | number
            | boolean,
): this
Marks the field as required when a condition is met. Can be used with a callback or with comparison operators to compare another field's value.
Type Parameters
- Operator extends ComparisonOperators
Parameters
- otherField: string
  Field name to compare or callback function
- operator: Operator
  Comparison operator (=, !=, in, notIn, >, <, >=, <=)
- expectedValue: Operator extends ArrayComparisonOperators
      ? (string | number | boolean)[]
      : Operator extends NumericComparisonOperators
          ? number
          : string
          | number
          | boolean
  Expected value to compare against
Returns this
Example
```
vine.string().optional().requiredWhen('role', '=', 'admin')
```
Example
```
vine.string().optional().requiredWhen('age', '>', 18)
```
Example
```
vine.string().optional().requiredWhen((field) => field.data.isAdmin === true)
```
Inherited from ConditionalValidations.requiredWhen
- Defined in src/schema/base/conditional_rules.ts:46
requiredWhen(callback: (field: FieldContext) => boolean): this
Marks the field as required when a condition is met. Can be used with a callback or with comparison operators to compare another field's value.
Parameters
- callback: (field: FieldContext) => boolean
Returns this
Example
```
vine.string().optional().requiredWhen('role', '=', 'admin')
```
Example
```
vine.string().optional().requiredWhen('age', '>', 18)
```
Example
```
vine.string().optional().requiredWhen((field) => field.data.isAdmin === true)
```
Inherited from ConditionalValidations.requiredWhen
- Defined in src/schema/base/conditional_rules.ts:55

requiredIfExists

requiredIfExists(fields: string | string[]): OptionalModifier<Schema>
Marks the field as required when all specified fields exist (are not undefined or null).
Parameters
- fields: string | string[]
  Field name or array of field names to check for existence
Returns OptionalModifier<Schema>
Example
```
vine.string().optional().requiredIfExists('email')
```
Example
```
vine.string().optional().requiredIfExists(['firstName', 'lastName'])
```
Inherited from ConditionalValidations.requiredIfExists
- Defined in src/schema/base/conditional_rules.ts:121

requiredIfAnyExists

requiredIfAnyExists(fields: string[]): OptionalModifier<Schema>
Marks the field as required when any one of the specified fields exists (is not undefined or null).
Parameters
- fields: string[]
  Array of field names to check for existence
Returns OptionalModifier<Schema>
Example
```
vine.string().optional().requiredIfAnyExists(['email', 'phone'])
```
Inherited from ConditionalValidations.requiredIfAnyExists
- Defined in src/schema/base/conditional_rules.ts:140

requiredIfMissing

requiredIfMissing(fields: string | string[]): OptionalModifier<Schema>
Marks the field as required when all specified fields are missing (undefined or null).
Parameters
- fields: string | string[]
  Field name or array of field names to check for absence
Returns OptionalModifier<Schema>
Example
```
vine.string().optional().requiredIfMissing('addressId')
```
Example
```
vine.string().optional().requiredIfMissing(['street', 'city'])
```
Inherited from ConditionalValidations.requiredIfMissing
- Defined in src/schema/base/conditional_rules.ts:161

requiredIfAnyMissing

requiredIfAnyMissing(fields: string[]): OptionalModifier<Schema>
Marks the field as required when any one of the specified fields is missing (undefined or null).
Parameters
- fields: string[]
  Array of field names to check for absence
Returns OptionalModifier<Schema>
Example
```
vine.string().optional().requiredIfAnyMissing(['street', 'city', 'zipCode'])
```
Inherited from ConditionalValidations.requiredIfAnyMissing
- Defined in src/schema/base/conditional_rules.ts:180

nullable

nullable(): NullableModifier<OptionalModifier<Schema>>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns NullableModifier<OptionalModifier<Schema>>
- Defined in src/schema/base/literal.ts:358

transform

transform<TransformedOutput>(
transformer: Transformer<OptionalModifier<Schema>, TransformedOutput>,
): TransformModifier<OptionalModifier<Schema>, TransformedOutput>
Apply transform on the final validated value. The transform method may convert the value to any new datatype.
Type Parameters
- TransformedOutput
Parameters
- transformer: Transformer<OptionalModifier<Schema>, TransformedOutput>
Returns TransformModifier<OptionalModifier<Schema>, TransformedOutput>
- Defined in src/schema/base/literal.ts:366

use

use(validation: Validation<any> | RuleBuilder): this
Push a validation to the validations chain.
Parameters
- validation: Validation<any> | RuleBuilder
Returns this
Implementation of WithCustomRules.use
Overrides ConditionalValidations.use
- Defined in src/schema/base/literal.ts:375

clone

clone(): this
Creates a fresh instance of the underlying schema type and wraps it inside the optional modifier

Returns this
Implementation of ConstructableLiteralSchema.clone
- Defined in src/schema/base/literal.ts:384

toJSONSchema

toJSONSchema(): JSONSchema7
Transforms your schema type into JSONSchema7

Returns JSONSchema7
Implementation of ConstructableLiteralSchema.toJSONSchema
- Defined in src/schema/base/literal.ts:396

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): FieldNode & {} & { subtype: string }
Compiles to compiler node
Parameters
- propertyName: string
- refs: RefsStore
- options: ParserOptions
Returns FieldNode & {} & { subtype: string }
Implementation of ConstructableLiteralSchema.[PARSE]
- Defined in src/schema/base/literal.ts:405

Class OptionalModifier<Schema>

Example

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OptionalModifier<Schema>

Properties

isOptional

[ITYPE]

[OTYPE]

[COTYPE]

validations

Accessors

allowNull

Returns boolean | undefined

Methods

requiredWhen

Type Parameters

Parameters

Returns this

Example

Example

Example

Parameters

Returns this

Example

Example

Example

requiredIfExists

Parameters

Returns OptionalModifier<Schema>

Example

Example

requiredIfAnyExists

Parameters

Returns OptionalModifier<Schema>

Example

requiredIfMissing

Parameters

Returns OptionalModifier<Schema>

Example

Example

requiredIfAnyMissing

Parameters

Returns OptionalModifier<Schema>

Example

nullable

Returns NullableModifier<OptionalModifier<Schema>>

transform

Type Parameters

Parameters

Returns TransformModifier<OptionalModifier<Schema>, TransformedOutput>

use

Parameters

Returns this

clone

Returns this

meta

Parameters

Returns MetaModifier<OptionalModifier<Schema>>

toJSONSchema

Returns JSONSchema7

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

Settings

On This Page