Class NullableModifier<Schema>

Modifies the schema type to allow null values in addition to the original schema type. This is useful for optional database fields or API responses that may contain null values.

Example

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

Type Parameters

Schema extends ConstructableSchema<any, any, any>
The underlying schema type to modify

Implements

ConstructableSchema<
    Schema[typeof ITYPE]
    | null,
    Schema[typeof OTYPE] | null,
    Schema[typeof COTYPE] | null,
>

Index

Constructors

constructor

new NullableModifier<Schema extends ConstructableSchema<any, any, any>>(
parent: Schema,
): NullableModifier<Schema>
Creates a new nullable modifier wrapping the given schema.
Type Parameters
- Schema extends ConstructableSchema<any, any, any>
Parameters
- parent: Schema
  The schema to make nullable
Returns NullableModifier<Schema>
- Defined in src/schema/base/main.ts:68

Properties

[ITYPE]

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

Define the input type of the schema, including null

[OTYPE]

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

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

[COTYPE]

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

Type marker for camelCase output type inference

Methods

optional

optional(): OptionalModifier<NullableModifier<Schema>>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<NullableModifier<Schema>>
A new OptionalModifier wrapping this nullable schema
- Defined in src/schema/base/main.ts:78

clone

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

Returns this
A cloned instance of this nullable modifier
Implementation of ConstructableSchema.clone
- Defined in src/schema/base/main.ts:88

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): CompilerNodes
Compiles to compiler node by delegating to the parent schema and setting the allowNull flag.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options
Returns CompilerNodes
Compiled compiler node with null support
Implementation of ConstructableSchema.[PARSE]
- Defined in src/schema/base/main.ts:101

Class NullableModifier<Schema>

Example

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NullableModifier<Schema>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Methods

optional

Returns OptionalModifier<NullableModifier<Schema>>

clone

Returns this

[PARSE]

Parameters

Returns CompilerNodes

Settings

On This Page