ObjectSchema | @bytesoftio/schema

Type parameters

TValue: object

Hierarchy

Schema<TValue>
- ObjectSchema

Implements

ValidationSchema<TValue>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ObjectSchema(objectShape?: ObjectShape<TValue>): ObjectSchema

- Defined in schemas/ObjectSchema.ts:106
Parameters
- Optional objectShape: ObjectShape<TValue>
Returns ObjectSchema

Properties

Protected allowUnknownKeysAndValues

allowUnknownKeysAndValues: boolean = false

Protected conditionalValidationDefinitions

conditionalValidationDefinitions: ValidationDefinition[] = []

Protected immutableMode

immutableMode: boolean = true

Protected Optional objectShape

objectShape: ObjectShape<TValue>

Protected sanitizerDefinitions

sanitizerDefinitions: SanitizerDefinition[] = []

Protected Optional unknownKeysSchema

unknownKeysSchema: StringSchema

Protected Optional unknownValuesSchema

unknownValuesSchema: StringSchema

Protected validationDefinitions

validationDefinitions: ValidationDefinition[] = []

Methods

Protected addConditionalValidationDefinition

addConditionalValidationDefinition(validationDefinition: ValidationDefinition): this

Inherited from StringSchema.addConditionalValidationDefinition
- Defined in Schema.ts:175
Parameters
- validationDefinition: ValidationDefinition
Returns this

Protected addSanitizerDefinition

addSanitizerDefinition(sanitizerDefinition: SanitizerDefinition): this

Inherited from StringSchema.addSanitizerDefinition
- Defined in Schema.ts:182
Parameters
- sanitizerDefinition: SanitizerDefinition
Returns this

Protected addValidationDefinition

addValidationDefinition(validationDefinition: ValidationDefinition): this

Inherited from StringSchema.addValidationDefinition
- Defined in Schema.ts:162
Parameters
- validationDefinition: ValidationDefinition
Returns this

allowUnknownKeys

allowUnknownKeys(): this

- Defined in schemas/ObjectSchema.ts:140
Returns this

also

also(validator: CustomValidation): this

Implementation of ValidationSchema.also

Inherited from StringSchema.also
- Defined in Schema.ts:44
Parameters
- validator: CustomValidation
Returns this

and

and(andValidator: CustomValidation): this

Implementation of ValidationSchema.and

Inherited from StringSchema.and
- Defined in Schema.ts:40
Parameters
- andValidator: CustomValidation
Returns this

Protected clone

clone(): this

Inherited from StringSchema.clone
- Defined in Schema.ts:196
Returns this

Protected cloneInstance

cloneInstance(): this

Overrides Schema.cloneInstance
- Defined in schemas/ObjectSchema.ts:44
Returns this

Protected customSanitizeBehavior

customSanitizeBehavior<TValue, TSanitizedValue>(value: TValue): TSanitizedValue

Overrides StringSchema.customSanitizeBehavior
- Defined in schemas/ObjectSchema.ts:95
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns TSanitizedValue

Protected customSanitizeBehaviorAsync

customSanitizeBehaviorAsync<TValue, TSanitizedValue>(value: TValue): Promise<TSanitizedValue>

Overrides StringSchema.customSanitizeBehaviorAsync
- Defined in schemas/ObjectSchema.ts:99
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns Promise<TSanitizedValue>

Protected customTestingBehavior

customTestingBehavior(value: any, testResult: boolean): boolean

Overrides StringSchema.customTestingBehavior
- Defined in schemas/ObjectSchema.ts:57
Parameters
- value: any
- testResult: boolean
Returns boolean

Protected customTestingBehaviorAsync

customTestingBehaviorAsync(value: any, testResult: boolean): Promise<boolean>

Overrides StringSchema.customTestingBehaviorAsync
- Defined in schemas/ObjectSchema.ts:66
Parameters
- value: any
- testResult: boolean
Returns Promise<boolean>

Protected customValidationBehavior

customValidationBehavior(value: any, errors: ValidationError[]): ValidationError[]

Overrides StringSchema.customValidationBehavior
- Defined in schemas/ObjectSchema.ts:75
Parameters
- value: any
- errors: ValidationError[]
Returns ValidationError[]

Protected customValidationBehaviorAsync

customValidationBehaviorAsync(value: any, errors: ValidationError[]): Promise<ValidationError[]>

Overrides StringSchema.customValidationBehaviorAsync
- Defined in schemas/ObjectSchema.ts:85
Parameters
- value: any
- errors: ValidationError[]
Returns Promise<ValidationError[]>

disallowUnknownKeys

disallowUnknownKeys(): this

- Defined in schemas/ObjectSchema.ts:147
Returns this

equals

equals(equal: LazyValue<object>, message?: CustomValidationMessage): this

- Defined in schemas/ObjectSchema.ts:128
Parameters
- equal: LazyValue<object>
- Optional message: CustomValidationMessage
Returns this

map

map(sanitizer: SanitizerFunction): this

Implementation of ValidationSchema.map

Inherited from StringSchema.map
- Defined in Schema.ts:53
Parameters
- sanitizer: SanitizerFunction
Returns this

optional

optional(message?: CustomValidationMessage): this

- Defined in schemas/ObjectSchema.ts:122
Parameters
- Optional message: CustomValidationMessage
Returns this

or

or(orValidator: CustomValidation): this

Implementation of ValidationSchema.or

Inherited from StringSchema.or
- Defined in Schema.ts:36
Parameters
- orValidator: CustomValidation
Returns this

Protected removeValidationDefinitionsOfType

removeValidationDefinitionsOfType(type: ValidationType): this

Inherited from StringSchema.removeValidationDefinitionsOfType
- Defined in Schema.ts:189
Parameters
- type: ValidationType
Returns this

required

required(required?: LazyValue<boolean>, message?: CustomValidationMessage): this

- Defined in schemas/ObjectSchema.ts:116
Parameters
- Optional required: LazyValue<boolean>
- Optional message: CustomValidationMessage
Returns this

sanitize

sanitize<TValue, TSanitizedValue>(value: TValue): TSanitizedValue

Implementation of ValidationSchema.sanitize

Inherited from StringSchema.sanitize
- Defined in Schema.ts:96
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns TSanitizedValue

sanitizeAndTest

sanitizeAndTest<TValue, TSanitizedValue>(value: any): [boolean, TSanitizedValue]

Implementation of ValidationSchema.sanitizeAndTest

Inherited from StringSchema.sanitizeAndTest
- Defined in Schema.ts:110
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns [boolean, TSanitizedValue]

sanitizeAndTestAsync

sanitizeAndTestAsync<TValue, TSanitizedValue>(value: any): Promise<[boolean, TSanitizedValue]>

Implementation of ValidationSchema.sanitizeAndTestAsync

Inherited from StringSchema.sanitizeAndTestAsync
- Defined in Schema.ts:117
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns Promise<[boolean, TSanitizedValue]>

sanitizeAndValidate

sanitizeAndValidate<TValue, TSanitizedValue>(value: any): [ValidationError[] | undefined, TSanitizedValue]

Implementation of ValidationSchema.sanitizeAndValidate

Inherited from StringSchema.sanitizeAndValidate
- Defined in Schema.ts:124
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns [ValidationError[] | undefined, TSanitizedValue]

sanitizeAndValidateAsync

sanitizeAndValidateAsync<TValue, TSanitizedValue>(value: any): Promise<[ValidationError[] | undefined, TSanitizedValue]>

Implementation of ValidationSchema.sanitizeAndValidateAsync

Inherited from StringSchema.sanitizeAndValidateAsync
- Defined in Schema.ts:131
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: any
Returns Promise<[ValidationError[] | undefined, TSanitizedValue]>

sanitizeAsync

sanitizeAsync<TValue, TSanitizedValue>(value: TValue): Promise<TSanitizedValue>

Implementation of ValidationSchema.sanitizeAsync

Inherited from StringSchema.sanitizeAsync
- Defined in Schema.ts:103
Type parameters
- TValue
- TSanitizedValue
Parameters
- value: TValue
Returns Promise<TSanitizedValue>

sanitizer

sanitizer(sanitizer: SanitizerFunction): this

Implementation of ValidationSchema.sanitizer

Inherited from StringSchema.sanitizer
- Defined in Schema.ts:58
Parameters
- sanitizer: SanitizerFunction
Returns this

shape

shape(objectShape?: ObjectShape<TValue>): this

- Defined in schemas/ObjectSchema.ts:133
Parameters
- Optional objectShape: ObjectShape<TValue>
Returns this

shapeUnknownKeys

shapeUnknownKeys(unknownKeysSchema: StringSchema): this

- Defined in schemas/ObjectSchema.ts:154
Parameters
- unknownKeysSchema: StringSchema
Returns this

shapeUnknownValues

shapeUnknownValues(unknownValuesSchema: StringSchema): this

- Defined in schemas/ObjectSchema.ts:161
Parameters
- unknownValuesSchema: StringSchema
Returns this

Protected skipClone

skipClone(fn: () => void): void

Inherited from StringSchema.skipClone
- Defined in Schema.ts:204
Parameters
- fn: () => void
  - - (): void
    - Returns void
Returns void

test

test(value: any): boolean

Implementation of ValidationSchema.test

Inherited from StringSchema.test
- Defined in Schema.ts:62
Parameters
- value: any
Returns boolean

testAsync

testAsync(value: any): Promise<boolean>

Implementation of ValidationSchema.testAsync

Inherited from StringSchema.testAsync
- Defined in Schema.ts:70
Parameters
- value: any
Returns Promise<boolean>

toCamelCaseKeys

toCamelCaseKeys(): this

- Defined in schemas/ObjectSchema.ts:172
Returns this

toCamelCaseKeysDeep

toCamelCaseKeysDeep(): this

- Defined in schemas/ObjectSchema.ts:176
Returns this

toConstantCaseKeys

toConstantCaseKeys(): this

- Defined in schemas/ObjectSchema.ts:196
Returns this

toConstantCaseKeysDeep

toConstantCaseKeysDeep(): this

- Defined in schemas/ObjectSchema.ts:200
Returns this

toDefault

toDefault(defaultValue?: LazyValue<object>): this

- Defined in schemas/ObjectSchema.ts:168
Parameters
- Default value defaultValue: LazyValue<object> = {}
Returns this

toKebabCaseKeys

toKebabCaseKeys(): this

- Defined in schemas/ObjectSchema.ts:188
Returns this

toKebabCaseKeysDeep

toKebabCaseKeysDeep(): this

- Defined in schemas/ObjectSchema.ts:192
Returns this

toMappedKeys

toMappedKeys(mapper: (value: any, key: string) => any): this

- Defined in schemas/ObjectSchema.ts:212
Parameters
- mapper: (value: any, key: string) => any
  - - (value: any, key: string): any
    - Parameters
      - value: any
      - key: string
      Returns any
Returns this

toMappedKeysDeep

toMappedKeysDeep(mapper: (value: any, key: string) => any): this

- Defined in schemas/ObjectSchema.ts:216
Parameters
- mapper: (value: any, key: string) => any
  - - (value: any, key: string): any
    - Parameters
      - value: any
      - key: string
      Returns any
Returns this

toMappedValues

toMappedValues(mapper: (value: any, key: string) => any): this

- Defined in schemas/ObjectSchema.ts:204
Parameters
- mapper: (value: any, key: string) => any
  - - (value: any, key: string): any
    - Parameters
      - value: any
      - key: string
      Returns any
Returns this

toMappedValuesDeep

toMappedValuesDeep(mapper: (value: any, key: string | number) => any): this

- Defined in schemas/ObjectSchema.ts:208
Parameters
- mapper: (value: any, key: string | number) => any
  - - (value: any, key: string | number): any
    - Parameters
      - value: any
      - key: string | number
      Returns any
Returns this

toSnakeCaseKeys

toSnakeCaseKeys(): this

- Defined in schemas/ObjectSchema.ts:180
Returns this

toSnakeCaseKeysDeep

toSnakeCaseKeysDeep(): this

- Defined in schemas/ObjectSchema.ts:184
Returns this

validate

validate(value: any): ValidationError[] | undefined

Implementation of ValidationSchema.validate

Inherited from StringSchema.validate
- Defined in Schema.ts:78
Parameters
- value: any
Returns ValidationError[] | undefined

validateAsync

validateAsync(value: any): Promise<ValidationError[] | undefined>

Implementation of ValidationSchema.validateAsync

Inherited from StringSchema.validateAsync
- Defined in Schema.ts:87
Parameters
- value: any
Returns Promise<ValidationError[] | undefined>

validator

validator(validator: CustomValidation): this

Implementation of ValidationSchema.validator

Inherited from StringSchema.validator
- Defined in Schema.ts:49
Parameters
- validator: CustomValidation
Returns this