Class VineRecord<Schema>

VineRecord represents an object of key-value pair in which keys are unknown

Type Parameters

Schema extends SchemaTypes

Hierarchy (View Summary)

BaseType<
    { [K: string]: Schema[typeof ITYPE] },
    { [K: string]: Schema[typeof OTYPE] },
    { [K: string]: Schema[typeof COTYPE] },
>
- VineRecord

Index

Constructors

constructor

new VineRecord<Schema extends SchemaTypes>(
    schema: Schema,
    options?: FieldOptions,
    validations?: Validation<any>[],
): VineRecord<Schema>
Type Parameters
- Schema extends SchemaTypes
Parameters
- schema: Schema
- Optionaloptions: FieldOptions
- Optionalvalidations: Validation<any>[]
Returns VineRecord<Schema>
Overrides BaseType.constructor
- Defined in src/schema/record/main.ts:59

Properties

[ITYPE]

"[ITYPE]": { [K: string]: Schema[typeof ITYPE] }

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": { [K: string]: Schema[typeof OTYPE] }

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

[COTYPE]

"[COTYPE]": { [K: string]: Schema[typeof COTYPE] }

Type marker for camelCase output type inference

`Static`rules

rules: {
    maxLength: (
        ...options: [options: { max: number }],
    ) => Validation<{ max: number }>;
    minLength: (
        ...options: [options: { min: number }],
    ) => Validation<{ min: number }>;
    fixedLength: (
        ...options: [options: { size: number }],
    ) => Validation<{ size: number }>;
    validateKeys: (
        ...options: [options: (keys: string[], field: FieldContext) => void],
    ) => Validation<(keys: string[], field: FieldContext) => void>;
} = ...

Default collection of record rules

[UNIQUE_NAME]

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

The property must be implemented for "unionOfTypes"

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 with.
Parameters
- callback: ParseFn
  Parser function to transform the input value
Returns this
This schema instance for method chaining
Example
```
vine.string().parse((value) => {
  return typeof value === 'string' ? value.trim() : value
})
```
Inherited from BaseType.parse
- Defined in src/schema/base/main.ts:372

use

use(validation: Validation<any> | RuleBuilder): this
Push a validation to the validations chain.
Parameters
- validation: Validation<any> | RuleBuilder
  Validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(vine.createRule((value) => {
  return value.length > 0
}))
```
Inherited from BaseType.use
- Defined in src/schema/base/main.ts:388

bail

bail(state: boolean): VineRecord<Schema>
Enable/disable the bail mode. In bail mode, the field validations are stopped after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns VineRecord<Schema>
This schema instance for method chaining
Inherited from BaseType.bail
- Defined in src/schema/base/main.ts:400

optional

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

Returns OptionalModifier<VineRecord<Schema>>
A new OptionalModifier wrapping this schema
Inherited from BaseType.optional
- Defined in src/schema/base/main.ts:411

nullable

nullable(): NullableModifier<VineRecord<Schema>>
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<VineRecord<Schema>>
A new NullableModifier wrapping this schema
Inherited from BaseType.nullable
- Defined in src/schema/base/main.ts:424

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): boolean
Checks if the value is of object type. The method must be implemented for "unionOfTypes"
Parameters
- value: unknown
Returns boolean
- Defined in src/schema/record/main.ts:55

minLength

minLength(expectedLength: number): VineRecord<Schema>
Enforce a minimum length on an object field
Parameters
- expectedLength: number
Returns VineRecord<Schema>
- Defined in src/schema/record/main.ts:67

maxLength

maxLength(expectedLength: number): VineRecord<Schema>
Enforce a maximum length on an object field
Parameters
- expectedLength: number
Returns VineRecord<Schema>
- Defined in src/schema/record/main.ts:74

fixedLength

fixedLength(expectedLength: number): VineRecord<Schema>
Enforce a fixed length on an object field
Parameters
- expectedLength: number
Returns VineRecord<Schema>
- Defined in src/schema/record/main.ts:81

validateKeys

validateKeys(
...args: [options: (keys: string[], field: FieldContext) => void],
): VineRecord<Schema>
Register a callback to validate the object keys
Parameters
- ...args: [options: (keys: string[], field: FieldContext) => void]
Returns VineRecord<Schema>
- Defined in src/schema/record/main.ts:88

clone

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

Returns this
Overrides BaseType.clone
- Defined in src/schema/record/main.ts:96

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): RecordNode
Compiles to record data type
Parameters
- propertyName: string
- refs: RefsStore
- options: ParserOptions
Returns RecordNode
Overrides BaseType.[PARSE]
- Defined in src/schema/record/main.ts:107

Class VineRecord<Schema>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineRecord<Schema>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Staticrules

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

Example

use

Parameters

Returns this

Example

bail

Parameters

Returns VineRecord<Schema>

optional

Returns OptionalModifier<VineRecord<Schema>>

nullable

Returns NullableModifier<VineRecord<Schema>>

[IS_OF_TYPE]

Parameters

Returns boolean

minLength

Parameters

Returns VineRecord<Schema>

maxLength

Parameters

Returns VineRecord<Schema>

fixedLength

Parameters

Returns VineRecord<Schema>

validateKeys

Parameters

Returns VineRecord<Schema>

clone

Returns this

[PARSE]

Parameters

Returns RecordNode

Settings

On This Page

`Static`rules