Class VineAccepted

VineAccepted represents a checkbox or acceptance field that must be checked or have an accepted value. This is commonly used for terms of service acceptance, privacy policy agreements, etc.

Accepted values are: 'on', '1', 'yes', 'true', true, or 1 The output is always normalized to the boolean value true.

Example

const schema = vine.object({
  termsAccepted: vine.accepted(),
  newsletter: vine.accepted().optional()
})

Example

// HTML form checkbox
// <input type="checkbox" name="terms" />
// When checked, sends "on" which is accepted

Hierarchy (View Summary)

BaseLiteralType<"on" | "1" | "yes" | "true" | true | 1, true, true>
- VineAccepted

Index

Constructors

constructor

new VineAccepted(
options?: Partial<FieldOptions>,
validations?: Validation<any>[],
): VineAccepted
Creates a new VineAccepted instance.
Parameters
- Optionaloptions: Partial<FieldOptions>
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineAccepted
Overrides BaseLiteralType.constructor
- Defined in src/schema/accepted/main.ts:57

Properties

`Static`rules

rules: {
accepted: (...options: [options?: undefined]) => Validation<undefined>;
} = ...

Static collection of all available validation rules for accepted fields

[SUBTYPE]

"[SUBTYPE]": string = 'checkbox'

The subtype identifier for the literal schema field

[ITYPE]

"[ITYPE]": true | 1 | "1" | "true" | "on" | "yes"

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": true

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

[COTYPE]

"[COTYPE]": true

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
}

options

options: FieldOptions

Configuration options for this field including bail mode, nullability, and parsing

Methods

clone

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

Returns this
A cloned instance of this VineAccepted schema
Overrides BaseLiteralType.clone
- Defined in src/schema/accepted/main.ts:67

toJSONSchema

toJSONSchema(): JSONSchema7
Transforms your schema type into JSONSchema7

Returns JSONSchema7
Inherited from BaseLiteralType.toJSONSchema
- Defined in src/schema/base/literal.ts:661

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:684

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:700

bail

bail(state: boolean): VineAccepted
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 VineAccepted
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:716

optional

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

Returns OptionalModifier<VineAccepted>
Inherited from BaseLiteralType.optional
- Defined in src/schema/base/literal.ts:725

nullable

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

transform

transform<TransformedOutput>(
transformer: Transformer<VineAccepted, TransformedOutput>,
): TransformModifier<VineAccepted, 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<VineAccepted, TransformedOutput>
Returns TransformModifier<VineAccepted, TransformedOutput>
Inherited from BaseLiteralType.transform
- Defined in src/schema/base/literal.ts:752

[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:768

Class VineAccepted

Example

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VineAccepted

Properties

Staticrules

[SUBTYPE]

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

options

Methods

clone

Returns this

toJSONSchema

Returns JSONSchema7

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineAccepted

Example

optional

Returns OptionalModifier<VineAccepted>

nullable

Returns NullableModifier<VineAccepted>

meta

Parameters

Returns MetaModifier<VineAccepted>

transform

Type Parameters

Parameters

Returns TransformModifier<VineAccepted, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

Settings

On This Page

`Static`rules

`Optional`dataTypeValidator