FormModel | formulr

Type parameters

Children: Record<string, BasicModel<unknown>>

Hierarchy

FieldSetModel<Children>
- FormModel

Implements

IModel<$FieldSetValue<Children>>

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new FormModel(children: Children): FormModel

Overrides FieldSetModel.constructor
- Defined in src/models/form.ts:45
Parameters
- children: Children
Returns FormModel

Properties

[FORM_ID]

[FORM_ID]: boolean

internal

[MODEL_ID]

[MODEL_ID]: boolean

internal

[SET_ID]

[SET_ID]: boolean

internal

childRegister$

childRegister$: Subject<string> = new Subject<string>()

childRemove$

childRemove$: Subject<string> = new Subject<string>()

children

children: Children

destroyOnUnmount

destroyOnUnmount: boolean = false

组件 unmount 的时候删除 model

error$

error$: BehaviorSubject<undefined | null | IValidateResult<Value>> = new BehaviorSubject<IMaybeError<Value>>(null)

id

id: string

initialValue

initialValue: Maybe<$FieldSetValue<Children>> = None()

internal: 初始值

isValidating$

isValidating$: BehaviorSubject<boolean> = new BehaviorSubject(false)

patchedValue

patchedValue: $FieldSetValue<Children> | null = null

internal

phantomValue

phantomValue: $FieldSetValue<Children>

internal

validate$

validate$: Subject<IValidation> = new Subject<IValidation>()

internal

validators

validators: IValidators<$FieldSetValue<Children>> = []

internal: 校验规则数组

Private workingValidators

workingValidators: Set<Observable<unknown>> = new Set<Observable<unknown>>()

internal

Accessors

error

get error(): undefined | null | IValidateResult<Value>
set error(error: IMaybeError<$FieldSetValue<Children>>): void

Inherited from BasicModel.error
- Defined in src/models/basic.ts:90
获取 model 上的错误信息

Returns undefined | null | IValidateResult<Value>
Inherited from BasicModel.error
- Defined in src/models/basic.ts:97
设置 model 上的错误信息

Parameters
- error: IMaybeError<$FieldSetValue<Children>>
Returns void

form

get form(): FormModel | null | undefined

Overrides BasicModel.form
- Defined in src/models/form.ts:43
Returns FormModel | null | undefined

owner

get owner(): BasicModel<any> | null
set owner(owner: BasicModel<any> | null): void

Overrides FieldSetModel.owner
- Defined in src/models/form.ts:35
Returns BasicModel<any> | null
Overrides FieldSetModel.owner
- Defined in src/models/form.ts:39
Parameters
- owner: BasicModel<any> | null
Returns void

Methods

addWorkingValidator

addWorkingValidator(v: Observable<unknown>): void

- Defined in src/models/form.ts:67
internal

Parameters
- v: Observable<unknown>
Returns void

clear

clear(): void

Implementation of IModel.clear

Inherited from FieldSetModel.clear

Overrides BasicModel.clear
- Defined in src/models/set.ts:180
清除 FieldSet 所有字段的值，同时清除 initialValue

Returns void

dirty

dirty(): boolean

Implementation of IModel.dirty

Inherited from FieldSetModel.dirty

Overrides BasicModel.dirty
- Defined in src/models/set.ts:235
是否 FieldSet 上有任意字段被修改过

dirty === !pristine

Returns boolean

dispose

dispose(): void

Implementation of IModel.dispose

Inherited from FieldSetModel.dispose

Overrides BasicModel.dispose
- Defined in src/models/set.ts:132
Returns void

get

get<Name>(name: Name): Children[Name] | undefined | null

Inherited from FieldSetModel.get
- Defined in src/models/set.ts:259
返回指定字段名对应的 model

Type parameters
- Name: keyof Children
Parameters
- name: Name
  
  字段名
Returns Children[Name] | undefined | null

getPatchedValue

getPatchedValue<T>(name: string): Maybe<T>

Inherited from FieldSetModel.getPatchedValue
- Defined in src/models/set.ts:69
internal

Type parameters
- T
Parameters
- name: string
Returns Maybe<T>

getRawValue

getRawValue(): $FieldSetValue<Children>

Implementation of IModel.getRawValue

Inherited from FieldSetModel.getRawValue

Overrides BasicModel.getRawValue
- Defined in src/models/set.ts:79
获取 FieldSet 的值

Returns $FieldSetValue<Children>

getSubmitValue

getSubmitValue(): any

Implementation of IModel.getSubmitValue

Inherited from FieldSetModel.getSubmitValue

Overrides BasicModel.getSubmitValue
- Defined in src/models/set.ts:94
获取 FieldSet 用于表单提交的值

Returns any

initialize

initialize(values: $FieldSetValue<Children>): void

Inherited from FieldSetModel.initialize

Overrides BasicModel.initialize
- Defined in src/models/set.ts:51
初始化 FieldSet 的值，并设置 initialValue

Parameters
- values: $FieldSetValue<Children>
  
  待初始化的值
Returns void

patchValue

patchValue(value: Partial<$FieldSetValue<Children>>): void

Inherited from FieldSetModel.patchValue

Overrides BasicModel.patchValue
- Defined in src/models/set.ts:163
更新 FieldSet 的值

Parameters
- value: Partial<$FieldSetValue<Children>>
  
  待更新的值
Returns void

pristine

pristine(): boolean

Implementation of IModel.pristine

Inherited from FieldSetModel.pristine

Overrides BasicModel.pristine
- Defined in src/models/set.ts:218
是否 FieldSet 上的所有字段都没有被修改过

Returns boolean

registerChild

registerChild(name: string, model: BasicModel<any>): void

Inherited from FieldSetModel.registerChild
- Defined in src/models/set.ts:111
在 FieldSet 上注册一个新的字段

Parameters
- name: string
  
  字段名
- model: BasicModel<any>
  
  字段对应的 model
Returns void

removeChild

removeChild(name: string): BasicModel<any>

Inherited from FieldSetModel.removeChild
- Defined in src/models/set.ts:124
在 FieldSet 上删除指定的字段

Parameters
- name: string
  
  字段名
Returns BasicModel<any>

removeWorkingValidator

removeWorkingValidator(v: Observable<unknown>): void

- Defined in src/models/form.ts:73
internal

Parameters
- v: Observable<unknown>
Returns void

reset

reset(): void

Implementation of IModel.reset

Inherited from FieldSetModel.reset

Overrides BasicModel.reset
- Defined in src/models/set.ts:191
重置 FieldValue 所有字段的值，如果存在 initialValue 就是用初始值，否则使用默认值

Returns void

touched

touched(): boolean

Implementation of IModel.touched

Inherited from FieldSetModel.touched

Overrides BasicModel.touched
- Defined in src/models/set.ts:243
是否 FieldSet 上有任意字段被 touch 过

Returns boolean

Protected triggerValidate

triggerValidate(option: ValidateOption): Promise<undefined | null | IValidateResult<Value>>

Inherited from BasicModel.triggerValidate
- Defined in src/models/basic.ts:70
Parameters
- option: ValidateOption
Returns Promise<undefined | null | IValidateResult<Value>>

Private updateIsValidating

updateIsValidating(): void

- Defined in src/models/form.ts:79
internal

Returns void

valid

valid(): boolean

Implementation of IModel.valid

Inherited from FieldSetModel.valid

Overrides BasicModel.valid
- Defined in src/models/set.ts:144
是否 FieldSet 所有字段都通过了校验

Returns boolean

validate

validate(option?: ValidateOption): Promise<undefined | null | IValidateResult<any> | (undefined | null | IValidateResult<any>)[]>

Implementation of IModel.validate

Overrides FieldSetModel.validate
- Defined in src/models/form.ts:62
执行整个 Form 的校验，默认会递归触发所有表单元素的校验

Parameters
- Default value option: ValidateOption = ValidateOption.Default | ValidateOption.IncludeChildrenRecursively
  
  表单校验的参数
Returns Promise<undefined | null | IValidateResult<any> | (undefined | null | IValidateResult<any>)[]>

Type parameters

Children: Record<string, BasicModel<unknown>>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

children: Children

Returns FormModel

Properties

[FORM_ID]

[MODEL_ID]

[SET_ID]

childRegister$

childRemove$

children

destroyOnUnmount

error$

id

initialValue

isValidating$

patchedValue

phantomValue

validate$

validators

Private workingValidators

Accessors

error

Returns undefined | null | IValidateResult<Value>

Parameters

error: IMaybeError<$FieldSetValue<Children>>

Returns void

form

Returns FormModel | null | undefined

owner

Returns BasicModel<any> | null

Parameters

owner: BasicModel<any> | null

Returns void

Methods

addWorkingValidator

Parameters

v: Observable<unknown>

Returns void

clear

Returns void

dirty

Returns boolean

dispose

Returns void

get

Type parameters

Name: keyof Children

Parameters

name: Name

Returns Children[Name] | undefined | null

getPatchedValue

Type parameters

T

Parameters

name: string

Returns Maybe<T>

getRawValue

Returns $FieldSetValue<Children>

getSubmitValue

Returns any

initialize

Parameters

values: $FieldSetValue<Children>

Returns void

patchValue

Parameters

value: Partial<$FieldSetValue<Children>>

Returns void

pristine