Interface IModel

Hierarchy

IModel

Index

Properties

Methods

Properties

isKlayModel

isKlayModel: boolean

spec

spec: IModelSpecification

Methods

applies

applies(appliesFunc?: IModelAppliesFunction): IModel

- Defined in typedefs.ts:46
Parameters
- Optional appliesFunc: IModelAppliesFunction
Returns IModel

children

children(children: IModelChildrenInput): IModel

- Defined in typedefs.ts:47
Parameters
- children: IModelChildrenInput
Returns IModel

clone

clone(): IModel

- Defined in typedefs.ts:32
Returns IModel

coerce

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

- Defined in typedefs.ts:51
Parameters
- coerce: ICoerceFunction
- Optional phase: ValidationPhase
Returns IModel
- Defined in typedefs.ts:52
Parameters
- coerce: IModelCoercionMap
Returns IModel

default

default(value?: any): IModel

- Defined in typedefs.ts:41
Parameters
- Optional value: any
Returns IModel

enum

enum(options: IModelEnumOption[]): IModel

- Defined in typedefs.ts:45
Parameters
- options: IModelEnumOption[]
Returns IModel

format

format(format: string): IModel

- Defined in typedefs.ts:36
Parameters
- format: string
Returns IModel

max

max(max: number | Date): IModel

- Defined in typedefs.ts:43
Parameters
- max: number | Date
Returns IModel

merge

merge(model: IModel): IModel

- Defined in typedefs.ts:50
Parameters
- model: IModel
Returns IModel

min

min(min: number | Date): IModel

- Defined in typedefs.ts:42
Parameters
- min: number | Date
Returns IModel

nullable

nullable(nullable?: undefined | true | false): IModel

- Defined in typedefs.ts:39
Parameters
- Optional nullable: undefined | true | false
Returns IModel

omit

omit(paths: string[]): IModel

- Defined in typedefs.ts:49
Parameters
- paths: string[]
Returns IModel

optional

optional(optional?: undefined | true | false): IModel

- Defined in typedefs.ts:38
Parameters
- Optional optional: undefined | true | false
Returns IModel

pick

pick(paths: string[]): IModel

- Defined in typedefs.ts:48
Parameters
- paths: string[]
Returns IModel

required

required(required?: undefined | true | false): IModel

- Defined in typedefs.ts:37
Parameters
- Optional required: undefined | true | false
Returns IModel

reset

reset(): IModel

- Defined in typedefs.ts:31
Returns IModel

size

size(size: number): IModel

- Defined in typedefs.ts:44
Parameters
- size: number
Returns IModel

strict

strict(strict?: undefined | true | false): IModel

- Defined in typedefs.ts:40
Parameters
- Optional strict: undefined | true | false
Returns IModel

type

type(type: string): IModel

- Defined in typedefs.ts:35
Parameters
- type: string
Returns IModel

validate

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

- Defined in typedefs.ts:33
Parameters
- value: any
- Optional options: IValidateOptions
Returns IValidationResult

validations

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

- Defined in typedefs.ts:53
Parameters
- validations: IModelValidationInput | IModelValidationInput[]
Returns IModel

Generated using TypeDoc