Class VineEnum<Values>

VineEnum represents an enum data type that performs validation against a pre-defined choices list. It ensures the input value matches one of the allowed enum values exactly.

Example

const schema = vine.enum(['active', 'inactive', 'pending'] as const)

const result = await vine.validate({
  schema,
  data: 'active' // Must be one of the defined values
})

Type Parameters

const Values extends readonly unknown[]
The readonly array of allowed enum values

Hierarchy (View Summary)

BaseLiteralType<Values[number], Values[number], Values[number]>
- VineEnum

Index

Constructors

constructor

new VineEnum<const Values extends readonly unknown[]>(
    values: Values | ((field: FieldContext) => Values),
    options?: FieldOptions,
    validations?: Validation<any>[],
): VineEnum<Values>
Creates a new VineEnum instance with the specified allowed values.
Type Parameters
- const Values extends readonly unknown[]
Parameters
- values: Values | ((field: FieldContext) => Values)
  Array of allowed values or function returning allowed values
- Optionaloptions: FieldOptions
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineEnum<Values>
Overrides BaseLiteralType.constructor
- Defined in src/schema/enum/main.ts:68

Properties

[ITYPE]

"[ITYPE]": Values[number]

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": Values[number]

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

[COTYPE]

"[COTYPE]": Values[number]

Type marker for camelCase output type inference

`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
}

`Static`rules

rules: {
    enum: (
        ...options: [
            options: {
                choices: readonly any[]
                | ((field: FieldContext) => readonly any[]);
            },
        ],
    ) => Validation<
        { choices: readonly any[]
        | ((field: FieldContext) => readonly any[]) },
    >;
} = ...

Static collection of all available validation rules for enums

[SUBTYPE]

"[SUBTYPE]": string = 'enum'

The subtype identifier for the literal schema field

Methods

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
Inherited from BaseLiteralType.parse
- 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 }))
```
Inherited from BaseLiteralType.use
- Defined in src/schema/base/literal.ts:494

bail

bail(state: boolean): VineEnum<Values>
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 VineEnum<Values>
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)
```
Inherited from BaseLiteralType.bail
- Defined in src/schema/base/literal.ts:510

optional

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

Returns OptionalModifier<VineEnum<Values>>
Inherited from BaseLiteralType.optional
- Defined in src/schema/base/literal.ts:519

nullable

nullable(): NullableModifier<VineEnum<Values>>
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<VineEnum<Values>>
Inherited from BaseLiteralType.nullable
- Defined in src/schema/base/literal.ts:530

transform

transform<TransformedOutput>(
transformer: Transformer<VineEnum<Values>, TransformedOutput>,
): TransformModifier<VineEnum<Values>, 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<VineEnum<Values>, TransformedOutput>
Returns TransformModifier<VineEnum<Values>, TransformedOutput>
Inherited from BaseLiteralType.transform
- 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
Inherited from BaseLiteralType.[PARSE]
- Defined in src/schema/base/literal.ts:554

getChoices

getChoices(): Values | ((field: FieldContext) => Values)
Returns the enum choices, either static values or function.

Returns Values | ((field: FieldContext) => Values)
The enum values or generator function
- Defined in src/schema/enum/main.ts:57

clone

clone(): this
Clones the VineEnum schema type. The applied options and validations are copied to the new instance.

Returns this
A cloned instance of this VineEnum schema
Overrides BaseLiteralType.clone
- Defined in src/schema/enum/main.ts:83

Class VineEnum<Values>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineEnum<Values>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

Staticrules

[SUBTYPE]

Methods

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineEnum<Values>

Example

optional

Returns OptionalModifier<VineEnum<Values>>

nullable

Returns NullableModifier<VineEnum<Values>>

transform

Type Parameters

Parameters

Returns TransformModifier<VineEnum<Values>, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

getChoices

Returns Values | ((field: FieldContext) => Values)

clone

Returns this

Settings

On This Page

`Optional`dataTypeValidator

`Static`rules