Class VineDate

VineDate represents a Date object created by parsing a string or number value as a date.

Hierarchy (View Summary)

BaseLiteralType<string | number, Date, Date>
- VineDate

Index

Constructors

constructor

new VineDate(
options?: Partial<FieldOptions> & DateFieldOptions,
validations?: Validation<any>[],
): VineDate
Parameters
- Optionaloptions: Partial<FieldOptions> & DateFieldOptions
- Optionalvalidations: Validation<any>[]
Returns VineDate
Overrides BaseLiteralType.constructor
- Defined in src/schema/date/main.ts:84

Properties

[ITYPE]

"[ITYPE]": string | number

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": Date

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

[COTYPE]

"[COTYPE]": Date

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: {
    equals: (
        ...options: [
            options: { expectedValue: string
            | ((field: FieldContext) => string) } & DateEqualsOptions,
        ],
    ) => Validation<
        { expectedValue: string
        | ((field: FieldContext) => string) } & DateEqualsOptions,
    >;
    after: (
        ...options: [
            options: {
                expectedValue: | string & { _?: undefined }
                | "today"
                | "tomorrow"
                | ((field: FieldContext) => string);
            } & DateEqualsOptions,
        ],
    ) => Validation<
        {
            expectedValue: | string & { _?: undefined }
            | "today"
            | "tomorrow"
            | ((field: FieldContext) => string);
        } & DateEqualsOptions,
    >;
    afterOrEqual: (
        ...options: [
            options: {
                expectedValue: | "today"
                | "tomorrow"
                | string & { _?: undefined }
                | ((field: FieldContext) => string);
            } & DateEqualsOptions,
        ],
    ) => Validation<
        {
            expectedValue: | "today"
            | "tomorrow"
            | string & { _?: undefined }
            | ((field: FieldContext) => string);
        } & DateEqualsOptions,
    >;
    before: (
        ...options: [
            options: {
                expectedValue: | "today"
                | string & { _?: undefined }
                | "yesterday"
                | ((field: FieldContext) => string);
            } & DateEqualsOptions,
        ],
    ) => Validation<
        {
            expectedValue: | "today"
            | string & { _?: undefined }
            | "yesterday"
            | ((field: FieldContext) => string);
        } & DateEqualsOptions,
    >;
    beforeOrEqual: (
        ...options: [
            options: {
                expectedValue: | "today"
                | "yesterday"
                | string & { _?: undefined }
                | ((field: FieldContext) => string);
            } & DateEqualsOptions,
        ],
    ) => Validation<
        {
            expectedValue: | "today"
            | "yesterday"
            | string & { _?: undefined }
            | ((field: FieldContext) => string);
        } & DateEqualsOptions,
    >;
    sameAs: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    notSameAs: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    afterField: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    afterOrSameAs: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    beforeField: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    beforeOrSameAs: (
        ...options: [options: { otherField: string } & DateEqualsOptions],
    ) => Validation<{ otherField: string } & DateEqualsOptions>;
    weekend: (...options: [options?: undefined]) => Validation<undefined>;
    weekday: (...options: [options?: undefined]) => Validation<undefined>;
} = ...

Available VineDate rules

[UNIQUE_NAME]

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

The property must be implemented for "unionOfTypes"

[SUBTYPE]

"[SUBTYPE]": string = 'date'

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

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

nullable

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

transform

transform<TransformedOutput>(
transformer: Transformer<VineDate, TransformedOutput>,
): TransformModifier<VineDate, 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<VineDate, TransformedOutput>
Returns TransformModifier<VineDate, 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): boolean
Checks if the value is of date type. The method must be implemented for "unionOfTypes"
Parameters
- value: unknown
Returns boolean
- Defined in src/schema/date/main.ts:75

equals

equals(
expectedValue: string | ((field: FieldContext) => string),
options?: DateEqualsOptions,
): this
The equals rule compares the input value to be same as the expected value.

By default, the comparions of day, month and years are performed.
Parameters
- expectedValue: string | ((field: FieldContext) => string)
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:95

after

after(
    expectedValue:
        | "today"
        | "tomorrow"
        | string & { _?: undefined }
        | ((field: FieldContext) => string),
    options?: DateEqualsOptions,
): this
The after rule compares the input value to be after the expected value.

By default, the comparions of day, month and years are performed.
Parameters
- expectedValue:
      | "today"
      | "tomorrow"
      | string & { _?: undefined }
      | ((field: FieldContext) => string)
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:108

afterOrEqual

afterOrEqual(
    expectedValue:
        | "today"
        | "tomorrow"
        | string & { _?: undefined }
        | ((field: FieldContext) => string),
    options?: DateEqualsOptions,
): this
The after or equal rule compares the input value to be after or equal to the expected value.

By default, the comparions of day, month and years are performed.
Parameters
- expectedValue:
      | "today"
      | "tomorrow"
      | string & { _?: undefined }
      | ((field: FieldContext) => string)
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:125

before

before(
    expectedValue:
        | "today"
        | "yesterday"
        | string & { _?: undefined }
        | ((field: FieldContext) => string),
    options?: DateEqualsOptions,
): this
The before rule compares the input value to be before the expected value.

By default, the comparions of day, month and years are performed.
Parameters
- expectedValue:
      | "today"
      | "yesterday"
      | string & { _?: undefined }
      | ((field: FieldContext) => string)
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:142

beforeOrEqual

beforeOrEqual(
    expectedValue:
        | "today"
        | "yesterday"
        | string & { _?: undefined }
        | ((field: FieldContext) => string),
    options?: DateEqualsOptions,
): this
The before rule compares the input value to be before the expected value.

By default, the comparions of day, month and years are performed.
Parameters
- expectedValue:
      | "today"
      | "yesterday"
      | string & { _?: undefined }
      | ((field: FieldContext) => string)
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:159

sameAs

sameAs(otherField: string, options?: DateEqualsOptions): this
The sameAs rule expects the input value to be same as the value of the other field.

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:176

notSameAs

notSameAs(otherField: string, options?: DateEqualsOptions): this
The notSameAs rule expects the input value to be different from the other field's value

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:187

afterField

afterField(otherField: string, options?: DateEqualsOptions): this
The afterField rule expects the input value to be after the other field's value.

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:197

afterOrSameAs

afterOrSameAs(otherField: string, options?: DateEqualsOptions): this
The afterOrSameAs rule expects the input value to be after or equal to the other field's value.

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:207

beforeField

beforeField(otherField: string, options?: DateEqualsOptions): this
The beforeField rule expects the input value to be before the other field's value.

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:217

beforeOrSameAs

beforeOrSameAs(otherField: string, options?: DateEqualsOptions): this
The beforeOrSameAs rule expects the input value to be before or same as the other field's value.

By default, the comparions of day, month and years are performed
Parameters
- otherField: string
- Optionaloptions: DateEqualsOptions
Returns this
- Defined in src/schema/date/main.ts:227

weekend

weekend(): this
The weekend rule ensures the date falls on a weekend

Returns this
- Defined in src/schema/date/main.ts:234

weekday

weekday(): this
The weekday rule ensures the date falls on a weekday

Returns this
- Defined in src/schema/date/main.ts:241

clone

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

Returns this
Overrides BaseLiteralType.clone
- Defined in src/schema/date/main.ts:249

Class VineDate

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VineDate

Properties

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

Staticrules

[UNIQUE_NAME]

[SUBTYPE]

Methods

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineDate

Example

optional

Returns OptionalModifier<VineDate>

nullable

Returns NullableModifier<VineDate>

transform

Type Parameters

Parameters

Returns TransformModifier<VineDate, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

[IS_OF_TYPE]

Parameters

Returns boolean

equals

Parameters

Returns this

after

Parameters

Returns this

afterOrEqual

Parameters

Returns this

before

Parameters

Returns this

beforeOrEqual

Parameters

Returns this

sameAs

Parameters

Returns this

notSameAs

Parameters

Returns this

afterField

Parameters

Returns this

afterOrSameAs

Parameters

Returns this

beforeField

Parameters

Returns this

beforeOrSameAs

Parameters

Returns this

weekend

Returns this

`Optional`dataTypeValidator

`Static`rules