Class Model

Hierarchy

Model

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Model(spec: IModelSpecification, options: IValidatorOptionsUnsafe): Model

- Defined in model.ts:30
Parameters
- spec: IModelSpecification
- options: IValidatorOptionsUnsafe
Returns Model

Properties

Private _options

_options: IValidatorOptions

isKlayModel

isKlayModel: boolean

spec

spec: IModelSpecification

Methods

Private _runHooks

_runHooks(phase: ModelHookPhase): void

- Defined in model.ts:298
Parameters
- phase: ModelHookPhase
Returns void

applies

applies(applies?: IModelAppliesFunction): IModel

- Defined in model.ts:158
Parameters
- Optional applies: IModelAppliesFunction
Returns IModel

children

children(children: IModelChildrenInput): IModel

- Defined in model.ts:167
Parameters
- children: IModelChildrenInput
Returns IModel

clone

clone(): IModel

- Defined in model.ts:64
Returns IModel

coerce

coerce(coerce: IModelCoercionMap | ICoerceFunction, phase?: ValidationPhase): IModel

- Defined in model.ts:247
Parameters
- coerce: IModelCoercionMap | ICoerceFunction
- Default value phase: ValidationPhase = ValidationPhase.Parse
Returns IModel

default

default(value: any): IModel

- Defined in model.ts:105
Parameters
- value: any
Returns IModel

enum

enum(options: IModelEnumOption[]): IModel

- Defined in model.ts:140
Parameters
- options: IModelEnumOption[]
Returns IModel

format

format(format: string): IModel

- Defined in model.ts:74
Parameters
- format: string
Returns IModel

max

max(value: number | Date): IModel

- Defined in model.ts:121
Parameters
- value: number | Date
Returns IModel

merge

merge(model: IModel): IModel

- Defined in model.ts:226
Parameters
- model: IModel
Returns IModel

min

min(value: number | Date): IModel

- Defined in model.ts:110
Parameters
- value: number | Date
Returns IModel

nullable

nullable(nullable?: boolean): IModel

- Defined in model.ts:93
Parameters
- Default value nullable: boolean = true
Returns IModel

omit

omit(paths: string[]): IModel

- Defined in model.ts:216
Parameters
- paths: string[]
Returns IModel

optional

optional(optional?: boolean): IModel

- Defined in model.ts:87
Parameters
- Default value optional: boolean = true
Returns IModel

pick

pick(paths: string[]): IModel

- Defined in model.ts:206
Parameters
- paths: string[]
Returns IModel

required

required(required?: boolean): IModel

- Defined in model.ts:81
Parameters
- Default value required: boolean = true
Returns IModel

reset

reset(): IModel

- Defined in model.ts:59
Returns IModel

size

size(value: number): IModel

- Defined in model.ts:132
Parameters
- value: number
Returns IModel

strict

strict(strict?: boolean): IModel

- Defined in model.ts:99
Parameters
- Default value strict: boolean = true
Returns IModel

type

type(type: string): IModel

- Defined in model.ts:68
Parameters
- type: string
Returns IModel

validate

validate(value: any, options?: IValidateOptions): IValidationResult

- Defined in model.ts:293
Parameters
- value: any
- Optional options: IValidateOptions
Returns IValidationResult

validations

validations(maybeValidations: IModelValidationInput | IModelValidationInput[]): IModel

- Defined in model.ts:267
Parameters
- maybeValidations: IModelValidationInput | IModelValidationInput[]
Returns IModel

Generated using TypeDoc