File

libs/common/src/lib/typed-forms/form-group-typed.ts

Deprecated

This has been rendered obsolete by Angular 14. Please use `FormGroup` from `@angular/forms` instead.

Description

Please use FormGroup from @angular/forms instead.

Extends

UntypedFormGroup

Index

Properties
Methods

Methods

addControl
addControl(name: K, control: AbstractControl<>)
Type parameters :
  • K
Parameters :
Name Type Optional
name K No
control AbstractControl<> No
Returns : void
contains
contains(controlName: ExtractStrings<T>)
Parameters :
Name Type Optional
controlName ExtractStrings<T> No
Returns : boolean
get
get(path: [K1])
Type parameters :
  • K1
Parameters :
Name Type Optional
path [K1] No
Returns : AbstractControl<>
get
get(path: [K1, K2])
Type parameters :
  • K1
  • K2
Parameters :
Name Type Optional
path [K1, K2] No
Returns : AbstractControl<>
get
get(path: [K1, K2, K3])
Type parameters :
  • K1
  • K2
  • K3
Parameters :
Name Type Optional
path [K1, K2, K3] No
Returns : AbstractControl<>
get
get(path: [K1, K2, K3, K4])
Type parameters :
  • K1
  • K2
  • K3
  • K4
Parameters :
Name Type Optional
path [K1, K2, K3, K4] No
Returns : AbstractControl<>
get
get(path: string)
Parameters :
Name Type Optional
path string No
Returns : AbstractControl
getError
getError(errorCode: K, path?: [K1])
Type parameters :
  • K
  • K1
Parameters :
Name Type Optional
errorCode K No
path [K1] Yes
Returns : | null
getError
getError(errorCode: K, path?: [K1, K2])
Type parameters :
  • K
  • K1
  • K2
Parameters :
Name Type Optional
errorCode K No
path [K1, K2] Yes
Returns : | null
getError
getError(errorCode: K, path?: [K1, K2, K3])
Type parameters :
  • K
  • K1
  • K2
  • K3
Parameters :
Name Type Optional
errorCode K No
path [K1, K2, K3] Yes
Returns : | null
getError
getError(errorCode: K, path?: string | any)
Type parameters :
  • K
Parameters :
Name Type Optional
errorCode K No
path string | any Yes
Returns : | null
getRawValue
getRawValue()
Returns : T
hasError
hasError(errorCode: ExtractStrings<E>, path?: [K1])
Type parameters :
  • K1
Parameters :
Name Type Optional
errorCode ExtractStrings<E> No
path [K1] Yes
Returns : boolean
hasError
hasError(errorCode: ExtractStrings<E>, path?: [K1, K2])
Type parameters :
  • K1
  • K2
Parameters :
Name Type Optional
errorCode ExtractStrings<E> No
path [K1, K2] Yes
Returns : boolean
hasError
hasError(errorCode: ExtractStrings<E>, path?: [K1, K2, K3])
Type parameters :
  • K1
  • K2
  • K3
Parameters :
Name Type Optional
errorCode ExtractStrings<E> No
path [K1, K2, K3] Yes
Returns : boolean
hasError
hasError(errorCode: ExtractStrings<E>, path?: string)
Parameters :
Name Type Optional
errorCode ExtractStrings<E> No
path string Yes
Returns : boolean
patchValue
patchValue(value: Partial, options?: ControlEventOptions)
Parameters :
Name Type Optional
value Partial<T> No
options ControlEventOptions Yes
Returns : void
removeControl
removeControl(name: ExtractStrings<T>)
Parameters :
Name Type Optional
name ExtractStrings<T> No
Returns : void
reset
reset(formState?: Partial, options?: ControlEventOptions)
Parameters :
Name Type Optional
formState Partial<T> Yes
options ControlEventOptions Yes
Returns : void
setControl
setControl(name: K, control: AbstractControl<>)
Type parameters :
  • K
Parameters :
Name Type Optional
name K No
control AbstractControl<> No
Returns : void
setErrors
setErrors(errors: Partial | null, opts?: EmitEvent)
Parameters :
Name Type Optional
errors Partial<E> | null No
opts EmitEvent Yes
Returns : void
setValue
setValue(value: T, options?: ControlEventOptions)
Parameters :
Name Type Optional
value T No
options ControlEventOptions Yes
Returns : void

Properties

errors
Type E | null
status
Type ControlState
statusChanges
Type Observable<ControlState>
value
Type T
valueChanges
Type Observable<T>
import { UntypedFormGroup } from '@angular/forms';
import { Observable } from 'rxjs';
import {
  AbstractControl,
  ControlEventOptions,
  ControlState,
  EmitEvent,
  ExtractStrings,
  Obj
} from './types';

/**
 * @deprecated This has been rendered obsolete by Angular 14.
 * Please use `FormGroup` from `@angular/forms` instead.
 */

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export interface FormGroupTyped<T extends Obj = any, E extends object = any>
  extends UntypedFormGroup {
  readonly value: T;
  readonly errors: E | null;
  readonly valueChanges: Observable<T>;
  readonly status: ControlState;
  readonly statusChanges: Observable<ControlState>;

  getRawValue(): T;

  get<K1 extends keyof T>(path: [K1]): AbstractControl<T[K1]>;
  get<K1 extends keyof T, K2 extends keyof T[K1]>(path: [K1, K2]): AbstractControl<T[K1][K2]>;
  get<K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(
    path: [K1, K2, K3]
  ): AbstractControl<T[K1][K2][K3]>;
  get<
    K1 extends keyof T,
    K2 extends keyof T[K1],
    K3 extends keyof T[K1][K2],
    K4 extends keyof T[K1][K2][K3]
  >(
    path: [K1, K2, K3, K4]
  ): AbstractControl<T[K1][K2][K3][K4]>;
  get(path: string): AbstractControl;

  addControl<K extends ExtractStrings<T>>(name: K, control: AbstractControl<T[K]>): void;
  removeControl(name: ExtractStrings<T>): void;
  contains(controlName: ExtractStrings<T>): boolean;
  setControl<K extends ExtractStrings<T>>(name: K, control: AbstractControl<T[K]>): void;

  setValue(value: T, options?: ControlEventOptions): void;
  patchValue(value: Partial<T>, options?: ControlEventOptions): void;
  reset(formState?: Partial<T>, options?: ControlEventOptions): void;

  hasError<K1 extends keyof T>(errorCode: ExtractStrings<E>, path?: [K1]): boolean;
  hasError<K1 extends keyof T, K2 extends keyof T[K1]>(
    errorCode: ExtractStrings<E>,
    path?: [K1, K2]
  ): boolean;
  hasError<K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(
    errorCode: ExtractStrings<E>,
    path?: [K1, K2, K3]
  ): boolean;
  hasError(errorCode: ExtractStrings<E>, path?: string): boolean;
  setErrors(errors: Partial<E> | null, opts?: EmitEvent): void;

  getError<K extends keyof E, K1 extends keyof T>(errorCode: K, path?: [K1]): E[K] | null;
  getError<K extends keyof E, K1 extends keyof T, K2 extends keyof T[K1]>(
    errorCode: K,
    path?: [K1, K2]
  ): E[K] | null;
  getError<
    K extends keyof E,
    K1 extends keyof T,
    K2 extends keyof T[K1],
    K3 extends keyof T[K1][K2]
  >(
    errorCode: K,
    path?: [K1, K2, K3]
  ): E[K] | null;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  getError<K extends keyof E>(errorCode: K, path?: string | any): E[K] | null;
}

results matching ""

    No results matching ""