refactor(forms): renamed FormState to FormControlState

Because the FormState type is actually intended for FormControl constructor, FormState is renamed to FormControlState.
angular · Jun 6, 2020 · fee6974 · fee6974
1 parent 35eaeef
commit fee6974
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 28 deletions.
diff --git a/goldens/public-api/forms/forms.d.ts b/goldens/public-api/forms/forms.d.ts
@@ -181,10 +181,7 @@ export declare class FormArray<Item = any> extends AbstractControl<Item[]> {
     }): void;
     push(control: AbstractControl<Item>): void;
     removeAt(index: number): void;
-    reset(value?: (Item | {
-        value: Item;
-        disabled: boolean;
-    })[], options?: {
+    reset(value?: FormControlState<Item>[], options?: {
         onlySelf?: boolean;
         emitEvent?: boolean;
     }): void;
@@ -209,7 +206,7 @@ export declare class FormArrayName extends ControlContainer implements OnInit, O
 
 export declare class FormBuilder {
     array<Item = any>(controlsConfig: FormControlConfig<Item>[], validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormArray;
-    control<T = any>(formState: FormState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormControl;
+    control<T = any>(formState: FormControlState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormControl;
     group<T extends object = any>(controlsConfig: {
         [key in keyof T]: FormControlConfig<T[key]>;
     }, options?: AbstractControlOptions | {
@@ -218,7 +215,7 @@ export declare class FormBuilder {
 }
 
 export declare class FormControl<T = any> extends AbstractControl<T> {
-    constructor(formState?: FormState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null);
+    constructor(formState?: FormControlState<T>, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null);
     patchValue(value: null | T, options?: {
         onlySelf?: boolean;
         emitEvent?: boolean;
@@ -227,7 +224,7 @@ export declare class FormControl<T = any> extends AbstractControl<T> {
     }): void;
     registerOnChange(fn: Function): void;
     registerOnDisabledChange(fn: (isDisabled: boolean) => void): void;
-    reset(formState?: FormState<T>, options?: {
+    reset(formState?: FormControlState<T>, options?: {
         onlySelf?: boolean;
         emitEvent?: boolean;
     }): void;
@@ -239,7 +236,7 @@ export declare class FormControl<T = any> extends AbstractControl<T> {
     }): void;
 }
 
-export declare type FormControlConfig<T> = AbstractControl<T> | FormState<T> | [FormState<T>, (ValidatorFn | ValidatorFn[] | AbstractControlOptions)?, (AsyncValidatorFn | AsyncValidatorFn[])?];
+export declare type FormControlConfig<T> = AbstractControl<T> | FormControlState<T> | [FormControlState<T>, (ValidatorFn | ValidatorFn[] | AbstractControlOptions)?, (AsyncValidatorFn | AsyncValidatorFn[])?];
 
 export declare class FormControlDirective extends NgControl implements OnChanges {
     get asyncValidator(): AsyncValidatorFn | null;
@@ -272,6 +269,11 @@ export declare class FormControlName extends NgControl implements OnChanges, OnD
     viewToModelUpdate(newValue: any): void;
 }
 
+export declare type FormControlState<T> = null | T | {
+    value: null | T;
+    disabled: boolean;
+};
+
 export declare class FormGroup<T extends object = any> extends AbstractControl<T> {
     controls: {
         [key in keyof T]: AbstractControl<T[key]>;
@@ -334,11 +336,6 @@ export declare class FormGroupName extends AbstractFormGroupDirective implements
 export declare class FormsModule {
 }
 
-export declare type FormState<T> = null | T | {
-    value: null | T;
-    disabled: boolean;
-};
-
 export declare class MaxLengthValidator implements Validator, OnChanges {
     maxlength: string | number;
     ngOnChanges(changes: SimpleChanges): void;

diff --git a/packages/forms/src/form_builder.ts b/packages/forms/src/form_builder.ts
@@ -9,7 +9,7 @@
 import {Injectable} from '@angular/core';
 
 import {AsyncValidatorFn, ValidatorFn} from './directives/validators';
-import {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormGroup, FormHooks, FormState} from './model';
+import {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormControlState, FormGroup, FormHooks} from './model';
 
 function isAbstractControlOptions(options: AbstractControlOptions|
                                   {[key: string]: any}): options is AbstractControlOptions {
@@ -23,9 +23,9 @@ function isAbstractControlOptions(options: AbstractControlOptions|
  */
 export type FormControlConfig<T> =
   | AbstractControl<T>
-  | FormState<T>
+  | FormControlState<T>
   | [
-      FormState<T>,
+      FormControlState<T>,
       (ValidatorFn | ValidatorFn[] | AbstractControlOptions)?,
       (AsyncValidatorFn | AsyncValidatorFn[])?
     ];
@@ -114,7 +114,7 @@ export class FormBuilder {
    * </code-example>
    */
   control<T = any>(
-      formState: FormState<T>,
+      formState: FormControlState<T>,
       validatorOrOpts?: ValidatorFn|ValidatorFn[]|AbstractControlOptions|null,
       asyncValidator?: AsyncValidatorFn|AsyncValidatorFn[]|null): FormControl {
     return new FormControl(formState, validatorOrOpts, asyncValidator);

diff --git a/packages/forms/src/forms.ts b/packages/forms/src/forms.ts
@@ -45,7 +45,7 @@ export {SelectMultipleControlValueAccessor} from './directives/select_multiple_c
 export {ɵNgSelectMultipleOption} from './directives/select_multiple_control_value_accessor';
 export {AsyncValidator, AsyncValidatorFn, CheckboxRequiredValidator, EmailValidator, MaxLengthValidator, MinLengthValidator, PatternValidator, RequiredValidator, ValidationErrors, Validator, ValidatorFn} from './directives/validators';
 export {FormBuilder, FormControlConfig} from './form_builder';
-export {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormGroup, FormState} from './model';
+export {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormControlState, FormGroup} from './model';
 export {NG_ASYNC_VALIDATORS, NG_VALIDATORS, Validators} from './validators';
 export {VERSION} from './version';
 

diff --git a/packages/forms/src/model.ts b/packages/forms/src/model.ts
@@ -15,7 +15,7 @@ import {toObservable} from './validators';
 /**
  * @publicApi
  */
-export type FormState<T> = null|T|{
+export type FormControlState<T> = null|T|{
   value: null|T;
   disabled: boolean
 };
@@ -1052,7 +1052,7 @@ export class FormControl<T = any> extends AbstractControl<T> {
    *
    */
   constructor(
-      formState: FormState<T> = null,
+      formState: FormControlState<T> = null,
       validatorOrOpts?: ValidatorFn|ValidatorFn[]|AbstractControlOptions|null,
       asyncValidator?: AsyncValidatorFn|AsyncValidatorFn[]|null) {
     super(
@@ -1137,8 +1137,8 @@ export class FormControl<T = any> extends AbstractControl<T> {
    * When false, no events are emitted.
    *
    */
-  reset(formState: FormState<T> = null, options: {onlySelf?: boolean, emitEvent?: boolean} = {}):
-      void {
+  reset(formState: FormControlState<T> = null, options: {onlySelf?: boolean,
+                                                         emitEvent?: boolean} = {}): void {
     this._applyFormState(formState);
     this.markAsPristine(options);
     this.markAsUntouched(options);
@@ -1970,12 +1970,8 @@ export class FormArray<Item = any> extends AbstractControl<Item[]> {
    * The configuration options are passed to the {@link AbstractControl#updateValueAndValidity
    * updateValueAndValidity} method.
    */
-  reset(
-      value: (Item|{
-        value: Item;
-        disabled: boolean
-      })[] = [],
-      options: {onlySelf?: boolean, emitEvent?: boolean} = {}): void {
+  reset(value: FormControlState<Item>[] = [], options: {onlySelf?: boolean,
+                                                        emitEvent?: boolean} = {}): void {
     this._forEachChild((control: AbstractControl, index: number) => {
       control.reset(value[index], {onlySelf: true, emitEvent: options.emitEvent});
     });