Class VineCamelCaseObject<Schema>

Converts schema properties to camelCase during validation. This is a wrapper around VineObject that automatically converts property names from snake_case to camelCase in the output.

Example

const schema = vine.object({
  first_name: vine.string(),
  last_name: vine.string()
}).camelCase()

// Output will have: { firstName: string, lastName: string }

Type Parameters

Schema extends VineObject<any, any, any, any>
The underlying VineObject schema type

Hierarchy (View Summary)

BaseType<Schema[typeof ITYPE], Schema[typeof COTYPE], Schema[typeof COTYPE]>
- VineCamelCaseObject

Index

Constructors

constructor

new VineCamelCaseObject<Schema extends VineObject<any, any, any, any>>(
schema: Schema,
): VineCamelCaseObject<Schema>
Creates a new VineCamelCaseObject instance wrapping the given schema.
Type Parameters
- Schema extends VineObject<any, any, any, any>
Parameters
- schema: Schema
  The VineObject schema to wrap with camelCase conversion
Returns VineCamelCaseObject<Schema>
Overrides BaseType.constructor
- Defined in src/schema/object/main.ts:72

Properties

[ITYPE]

"[ITYPE]": Schema[typeof ITYPE]

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": Schema[typeof COTYPE]

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

[COTYPE]

"[COTYPE]": Schema[typeof COTYPE]

Type marker for camelCase output type inference

[UNIQUE_NAME]

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

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 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): VineCamelCaseObject<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 VineCamelCaseObject<Schema>
This schema instance for method chaining
Inherited from BaseType.bail
- Defined in src/schema/base/main.ts:400

optional

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

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

nullable

nullable(): NullableModifier<VineCamelCaseObject<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<VineCamelCaseObject<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
Type checker function to determine if a value is an object. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns boolean
True if the value is a non-null object and not an array
- Defined in src/schema/object/main.ts:63

clone

clone(): this
Clone object with camelCase conversion preserved.

Returns this
A cloned instance of this VineCamelCaseObject schema
Overrides BaseType.clone
- Defined in src/schema/object/main.ts:82

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): ObjectNode
Compiles the schema type to a compiler node with camelCase enabled.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options
Returns ObjectNode
Compiled object node with camelCase conversion
Overrides BaseType.[PARSE]
- Defined in src/schema/object/main.ts:94

Class VineCamelCaseObject<Schema>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineCamelCaseObject<Schema>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

Example

use

Parameters

Returns this

Example

bail

Parameters

Returns VineCamelCaseObject<Schema>

optional

Returns OptionalModifier<VineCamelCaseObject<Schema>>

nullable

Returns NullableModifier<VineCamelCaseObject<Schema>>

[IS_OF_TYPE]

Parameters

Returns boolean

clone

Returns this

[PARSE]

Parameters

Returns ObjectNode

Settings

On This Page