Class BaseLiteralType<Input, Output, CamelCaseOutput>`Abstract`

The base type for creating a custom literal type. Literal types are schema types that have no children elements, such as strings, numbers, booleans, and dates.

Example

class CustomLiteralType extends BaseLiteralType<string, string, string> {
  [SUBTYPE] = 'custom'
  clone() { return new CustomLiteralType() }
}

Type Parameters

Input
The expected input type for this schema
Output
The output type after validation and transformation
CamelCaseOutput
The output type with camelCase field names

Hierarchy (View Summary)

default
- BaseLiteralType

Implements

Index

Constructors

constructor

new BaseLiteralType<Input, Output, CamelCaseOutput>(
options?: Partial<FieldOptions>,
validations?: Validation<any>[],
): BaseLiteralType<Input, Output, CamelCaseOutput>
Creates a new BaseLiteralType instance with optional configuration.
Type Parameters
- Input
- Output
- CamelCaseOutput
Parameters
- Optionaloptions: Partial<FieldOptions>
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns BaseLiteralType<Input, Output, CamelCaseOutput>
Overrides Macroable.constructor
- Defined in src/schema/base/literal.ts:407

Properties

[ITYPE]

"[ITYPE]": Input

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": Output

The output value type of the field after validation. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": CamelCaseOutput

Type marker for camelCase output type inference

`Abstract`[SUBTYPE]

"[SUBTYPE]": string

Specify the subtype of the literal schema field. This is used by the compiler to identify the schema type.

`Optional`dataTypeValidator

dataTypeValidator?: Validation<any>

The validation to use for validating the schema data type. Using a data type validator guards custom rules to only run when the data type validation passes.

Example

class StringSchema extends BaseLiteralType {
  dataTypeValidator = stringDataTypeRule
}

Methods

`Abstract`clone

clone(): this
The child class must implement the clone method to create a deep copy of the schema instance.

Returns this
A cloned instance of this schema
Implementation of ConstructableLiteralSchema.clone
- Defined in src/schema/base/literal.ts:377

parse

parse(callback: ParseFn): this
Define a method to parse the input value. The method is invoked before any validation and hence you must perform type-checking to know the value you are working it.
Parameters
- callback: ParseFn
Returns this
- Defined in src/schema/base/literal.ts:478

use

use(validation: Validation<any> | RuleBuilder): this
Adds a validation rule to the schema's validation chain. Rules are executed in the order they are added.
Parameters
- validation: Validation<any> | RuleBuilder
  The validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(minLength({ length: 3 }))
vine.number().use(customRule({ strict: true }))
```
Implementation of WithCustomRules.use
- Defined in src/schema/base/literal.ts:494

bail

bail(state: boolean): BaseLiteralType<Input, Output, CamelCaseOutput>
Enable/disable bail mode for this field. In bail mode, field validations stop after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns BaseLiteralType<Input, Output, CamelCaseOutput>
This schema instance for method chaining
Example
```
vine.string().bail(false) // Continue validation after first error
vine.number().bail(true)  // Stop after first error (default)
```
- Defined in src/schema/base/literal.ts:510

optional

optional(): OptionalModifier<BaseLiteralType<Input, Output, CamelCaseOutput>>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<BaseLiteralType<Input, Output, CamelCaseOutput>>
- Defined in src/schema/base/literal.ts:519

nullable

nullable(): NullableModifier<BaseLiteralType<Input, Output, CamelCaseOutput>>
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<BaseLiteralType<Input, Output, CamelCaseOutput>>
- Defined in src/schema/base/literal.ts:530

transform

transform<TransformedOutput>(
    transformer: Transformer<
        BaseLiteralType<Input, Output, CamelCaseOutput>,
        TransformedOutput,
    >,
): TransformModifier<
    BaseLiteralType<Input, Output, CamelCaseOutput>,
    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<BaseLiteralType<Input, Output, CamelCaseOutput>, TransformedOutput>
Returns TransformModifier<
BaseLiteralType<Input, Output, CamelCaseOutput>,
TransformedOutput,
>
- Defined in src/schema/base/literal.ts:538

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): FieldNode & {} & { subtype: string }
Compiles the literal schema type into a compiler node. This method transforms the schema definition into a format that the validation compiler can process.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options including camelCase conversion
Returns FieldNode & {} & { subtype: string }
Compiled literal node with subtype information
Implementation of ConstructableLiteralSchema.[PARSE]
- Defined in src/schema/base/literal.ts:554

Class BaseLiteralType<Input, Output, CamelCaseOutput>Abstract

Example

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseLiteralType<Input, Output, CamelCaseOutput>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Abstract[SUBTYPE]

OptionaldataTypeValidator

Example

Methods

Abstractclone

Returns this

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns BaseLiteralType<Input, Output, CamelCaseOutput>

Example

optional

Returns OptionalModifier<BaseLiteralType<Input, Output, CamelCaseOutput>>

nullable

Returns NullableModifier<BaseLiteralType<Input, Output, CamelCaseOutput>>

transform

Type Parameters

Parameters

Returns TransformModifier< BaseLiteralType<Input, Output, CamelCaseOutput>, TransformedOutput,>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

Settings

On This Page

Class BaseLiteralType<Input, Output, CamelCaseOutput>`Abstract`

`Abstract`[SUBTYPE]

`Optional`dataTypeValidator

`Abstract`clone

Returns TransformModifier<
BaseLiteralType<Input, Output, CamelCaseOutput>,
TransformedOutput,
>