Class VineString

VineString represents a string value in the validation schema. It provides comprehensive string validation with built-in rules for common patterns like email, URL, UUID, and more.

Example

const schema = vine.string()
  .email()
  .minLength(5)
  .maxLength(100)

const result = await vine.validate({
  schema,
  data: 'user@example.com'
})

Hierarchy (View Summary)

BaseLiteralType<string, string, string>
- VineString

Constructors

constructor

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

Properties

[ITYPE]

"[ITYPE]": string

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": string

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

[COTYPE]

"[COTYPE]": string

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: {
    in: (
        ...options: [
            options: { choices: string[]
            | ((field: FieldContext) => string[]) },
        ],
    ) => Validation<
        { choices: string[]
        | ((field: FieldContext) => string[]) },
    >;
    jwt: (...options: [options?: undefined]) => Validation<undefined>;
    url: (
        ...options: [options?: IsURLOptions],
    ) => Validation<IsURLOptions | undefined>;
    iban: (...options: [options?: undefined]) => Validation<undefined>;
    uuid: (
        ...options: [options?: { version?: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8)[] }],
    ) => Validation<
        { version?: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8)[] }
        | undefined,
    >;
    ulid: (...options: [options?: undefined]) => Validation<undefined>;
    trim: (...options: [options?: undefined]) => Validation<undefined>;
    email: (
        ...options: [options?: IsEmailOptions],
    ) => Validation<IsEmailOptions | undefined>;
    alpha: (
        ...options: [options?: AlphaOptions],
    ) => Validation<AlphaOptions | undefined>;
    ascii: (...options: [options?: undefined]) => Validation<undefined>;
    notIn: (
        ...options: [
            options: { list: string[]
            | ((field: FieldContext) => string[]) },
        ],
    ) => Validation<{ list: string[] | ((field: FieldContext) => string[]) }>;
    regex: (...options: [options: RegExp]) => Validation<RegExp>;
    escape: (...options: [options?: undefined]) => Validation<undefined>;
    sameAs: (
        ...options: [options: { otherField: string }],
    ) => Validation<{ otherField: string }>;
    mobile: (
        ...options: [
            options?: | MobileOptions
            | ((field: FieldContext) => MobileOptions | undefined),
        ],
    ) => Validation<
        | MobileOptions
        | ((field: FieldContext) => MobileOptions | undefined)
        | undefined,
    >;
    string: (...options: [options?: undefined]) => Validation<undefined>;
    hexCode: (...options: [options?: undefined]) => Validation<undefined>;
    passport: (
        ...options: [
            options: PassportOptions
            | ((field: FieldContext) => PassportOptions),
        ],
    ) => Validation<
        PassportOptions
        | ((field: FieldContext) => PassportOptions),
    >;
    endsWith: (
        ...options: [options: { substring: string }],
    ) => Validation<{ substring: string }>;
    confirmed: (
        ...options: [
            options?: { confirmationField?: string }
            | { as?: string },
        ],
    ) => Validation<
        { confirmationField?: string }
        | { as?: string }
        | undefined,
    >;
    activeUrl: (...options: [options?: undefined]) => Validation<undefined>;
    minLength: (
        ...options: [options: { min: number }],
    ) => Validation<{ min: number }>;
    notSameAs: (
        ...options: [options: { otherField: string }],
    ) => Validation<{ otherField: string }>;
    maxLength: (
        ...options: [options: { max: number }],
    ) => Validation<{ max: number }>;
    ipAddress: (
        ...options: [options?: { version: 4 | 6 }],
    ) => Validation<{ version: 4 | 6 } | undefined>;
    creditCard: (
        ...options: [
            options?: | CreditCardOptions
            | ((field: FieldContext) => void | CreditCardOptions | undefined),
        ],
    ) => Validation<
        | CreditCardOptions
        | ((field: FieldContext) => void | CreditCardOptions | undefined)
        | undefined,
    >;
    postalCode: (
        ...options: [
            options?: | PostalCodeOptions
            | ((field: FieldContext) => void | PostalCodeOptions | undefined),
        ],
    ) => Validation<
        | PostalCodeOptions
        | ((field: FieldContext) => void | PostalCodeOptions | undefined)
        | undefined,
    >;
    startsWith: (
        ...options: [options: { substring: string }],
    ) => Validation<{ substring: string }>;
    toUpperCase: (
        ...options: [options?: string | string[]],
    ) => Validation<string | string[] | undefined>;
    toLowerCase: (
        ...options: [options?: string | string[]],
    ) => Validation<string | string[] | undefined>;
    toCamelCase: (...options: [options?: undefined]) => Validation<undefined>;
    fixedLength: (
        ...options: [options: { size: number }],
    ) => Validation<{ size: number }>;
    coordinates: (...options: [options?: undefined]) => Validation<undefined>;
    normalizeUrl: (
        ...options: [options?: Options],
    ) => Validation<Options | undefined>;
    alphaNumeric: (
        ...options: [options?: AlphaOptions],
    ) => Validation<AlphaOptions | undefined>;
    normalizeEmail: (
        ...options: [options?: NormalizeEmailOptions],
    ) => Validation<NormalizeEmailOptions | undefined>;
} = ...

Static collection of all available validation rules for strings

[SUBTYPE]

"[SUBTYPE]": string = 'string'

The subtype identifier for the literal schema field

[UNIQUE_NAME]

"[UNIQUE_NAME]": string = 'vine.string'

Unique name identifier for union type resolution

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): VineString
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 VineString
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<VineString>
Mark the field under validation as optional. An optional field allows both null and undefined values.

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

nullable

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

transform

transform<TransformedOutput>(
transformer: Transformer<VineString, TransformedOutput>,
): TransformModifier<VineString, 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<VineString, TransformedOutput>
Returns TransformModifier<VineString, 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

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): value is string
Type checker function to determine if a value is a string. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns value is string
True if the value is a string
- Defined in src/schema/string/main.ts:136

url

url(...args: [options?: IsURLOptions]): VineString
Validates the value to be a valid URL.
Parameters
- ...args: [options?: IsURLOptions]
  Optional URL validation options
Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:157

activeUrl

activeUrl(): VineString
Validates the value to be an active URL by making an HTTP request.

Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:166

email

email(...args: [options?: IsEmailOptions]): VineString
Validates the value to be a valid email address.
Parameters
- ...args: [options?: IsEmailOptions]
  Optional email validation options
Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:176

mobile

mobile(
    ...args: [
        options?: | MobileOptions
        | ((field: FieldContext) => MobileOptions | undefined),
    ],
): VineString
Validates the value to be a valid mobile number
Parameters
- ...args: [options?: MobileOptions | ((field: FieldContext) => MobileOptions | undefined)]
Returns VineString
- Defined in src/schema/string/main.ts:183

ipAddress

ipAddress(version?: 4 | 6): VineString
Validates the value to be a valid IP address.
Parameters
- Optionalversion: 4 | 6
Returns VineString
- Defined in src/schema/string/main.ts:190

hexCode

hexCode(): VineString
Validates the value to be a valid hex color code

Returns VineString
- Defined in src/schema/string/main.ts:197

regex

regex(expression: RegExp): VineString
Validates the value against a regular expression
Parameters
- expression: RegExp
Returns VineString
- Defined in src/schema/string/main.ts:204

alpha

alpha(options?: AlphaOptions): VineString
Validates the value to contain only letters
Parameters
- Optionaloptions: AlphaOptions
Returns VineString
- Defined in src/schema/string/main.ts:211

alphaNumeric

alphaNumeric(options?: AlphaOptions): VineString
Validates the value to contain only letters and numbers
Parameters
- Optionaloptions: AlphaOptions
Returns VineString
- Defined in src/schema/string/main.ts:219

minLength

minLength(expectedLength: number): VineString
Enforce a minimum length on a string field.
Parameters
- expectedLength: number
  The minimum required length
Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:229

maxLength

maxLength(expectedLength: number): VineString
Enforce a maximum length on a string field.
Parameters
- expectedLength: number
  The maximum allowed length
Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:239

fixedLength

fixedLength(expectedLength: number): VineString
Enforce a fixed length on a string field.
Parameters
- expectedLength: number
  The exact required length
Returns VineString
This string schema instance for method chaining
- Defined in src/schema/string/main.ts:249

confirmed

confirmed(options?: { confirmationField: string }): VineString
Ensure the field under validation is confirmed by having another field with the same name.
Parameters
- Optionaloptions: { confirmationField: string }
Returns VineString
- Defined in src/schema/string/main.ts:257

trim

trim(): VineString
Trims whitespaces around the string value

Returns VineString
- Defined in src/schema/string/main.ts:264

normalizeEmail

normalizeEmail(options?: NormalizeEmailOptions): VineString
Normalizes the email address
Parameters
- Optionaloptions: NormalizeEmailOptions
Returns VineString
- Defined in src/schema/string/main.ts:271

toUpperCase

toUpperCase(): VineString
Converts the field value to UPPERCASE.

Returns VineString
- Defined in src/schema/string/main.ts:278

toLowerCase

toLowerCase(): VineString
Converts the field value to lowercase.

Returns VineString
- Defined in src/schema/string/main.ts:285

toCamelCase

toCamelCase(): VineString
Converts the field value to camelCase.

Returns VineString
- Defined in src/schema/string/main.ts:292

escape

escape(): VineString
Escape string for HTML entities

Returns VineString
- Defined in src/schema/string/main.ts:299

normalizeUrl

normalizeUrl(...args: [options?: Options]): VineString
Normalize a URL
Parameters
- ...args: [options?: Options]
Returns VineString
- Defined in src/schema/string/main.ts:306

startsWith

startsWith(substring: string): VineString
Ensure the value starts with the pre-defined substring
Parameters
- substring: string
Returns VineString
- Defined in src/schema/string/main.ts:313

endsWith

endsWith(substring: string): VineString
Ensure the value ends with the pre-defined substring
Parameters
- substring: string
Returns VineString
- Defined in src/schema/string/main.ts:320

sameAs

sameAs(otherField: string): VineString
Ensure the value ends with the pre-defined substring
Parameters
- otherField: string
Returns VineString
- Defined in src/schema/string/main.ts:327

notSameAs

notSameAs(otherField: string): VineString
Ensure the value ends with the pre-defined substring
Parameters
- otherField: string
Returns VineString
- Defined in src/schema/string/main.ts:334

in

in(choices: string[] | ((field: FieldContext) => string[])): VineString
Ensure the field's value under validation is a subset of the pre-defined list.
Parameters
- choices: string[] | ((field: FieldContext) => string[])
Returns VineString
- Defined in src/schema/string/main.ts:341

notIn

notIn(list: string[] | ((field: FieldContext) => string[])): VineString
Ensure the field's value under validation is not inside the pre-defined list.
Parameters
- list: string[] | ((field: FieldContext) => string[])
Returns VineString
- Defined in src/schema/string/main.ts:348

creditCard

creditCard(
    ...args: [
        options?: | CreditCardOptions
        | ((field: FieldContext) => void | CreditCardOptions | undefined),
    ],
): VineString
Validates the value to be a valid credit card number
Parameters
- ...args: [
  options?: | CreditCardOptions
  | ((field: FieldContext) => void | CreditCardOptions | undefined),
  ]
Returns VineString
- Defined in src/schema/string/main.ts:355

passport

passport(
    ...args: [
        options: PassportOptions
        | ((field: FieldContext) => PassportOptions),
    ],
): VineString
Validates the value to be a valid passport number
Parameters
- ...args: [options: PassportOptions | ((field: FieldContext) => PassportOptions)]
Returns VineString
- Defined in src/schema/string/main.ts:362

postalCode

postalCode(
    ...args: [
        options?: | PostalCodeOptions
        | ((field: FieldContext) => void | PostalCodeOptions | undefined),
    ],
): VineString
Validates the value to be a valid postal code
Parameters
- ...args: [
  options?: | PostalCodeOptions
  | ((field: FieldContext) => void | PostalCodeOptions | undefined),
  ]
Returns VineString
- Defined in src/schema/string/main.ts:369

uuid

uuid(
...args: [options?: { version?: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8)[] }],
): VineString
Validates the value to be a valid UUID
Parameters
- ...args: [options?: { version?: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8)[] }]
Returns VineString
- Defined in src/schema/string/main.ts:376

ulid

ulid(): VineString
Validates the value to be a valid ULID

Returns VineString
- Defined in src/schema/string/main.ts:383

ascii

ascii(): VineString
Validates the value contains ASCII characters only

Returns VineString
- Defined in src/schema/string/main.ts:390

iban

iban(): VineString
Validates the value to be a valid IBAN number

Returns VineString
- Defined in src/schema/string/main.ts:397

jwt

jwt(): VineString
Validates the value to be a valid JWT token

Returns VineString
- Defined in src/schema/string/main.ts:405

coordinates

coordinates(): VineString
Ensure the value is a string with latitude and longitude coordinates

Returns VineString
- Defined in src/schema/string/main.ts:412

clone

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

Returns this
A cloned instance of this VineString schema
Overrides BaseLiteralType.clone
- Defined in src/schema/string/main.ts:422

Class VineString

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VineString

Properties

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

Staticrules

[SUBTYPE]

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineString

Example

optional

Returns OptionalModifier<VineString>

nullable

Returns NullableModifier<VineString>

transform

Type Parameters

Parameters

Returns TransformModifier<VineString, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

[IS_OF_TYPE]

Parameters

Returns value is string

url

Parameters

Returns VineString

activeUrl

Returns VineString

email

Parameters

Returns VineString

mobile

Parameters

Returns VineString

ipAddress

Parameters

Returns VineString

hexCode

Returns VineString

regex

Parameters

Returns VineString

alpha

Parameters

Returns VineString

alphaNumeric

Parameters

Returns VineString

minLength

Parameters

Returns VineString

maxLength

Parameters

Returns VineString

fixedLength

Parameters

Returns VineString

`Optional`dataTypeValidator

`Static`rules