File

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

Deprecated

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

Description

Please use FormArray from @angular/forms instead.

Extends

UntypedFormArray

Index

Properties
Methods

Methods

at
at(index: number)
Parameters :
Name Type Optional
index number No
Returns : AbstractControl<T>
getError
getError(errorCode: K, path?: ControlPath)
Type parameters :
  • K
Parameters :
Name Type Optional
errorCode K No
path ControlPath Yes
Returns : any
getRawValue
getRawValue()
Returns : T[]
hasError
hasError(errorCode: ExtractStrings<E>, path?: ControlPath)
Parameters :
Name Type Optional
errorCode ExtractStrings<E> No
path ControlPath Yes
Returns : boolean
insert
insert(index: number, control: AbstractControl<T>)
Parameters :
Name Type Optional
index number No
control AbstractControl<T> No
Returns : void
markAsDirty
markAsDirty(opts?: OnlySelf)
Parameters :
Name Type Optional
opts OnlySelf Yes
Returns : void
markAsPristine
markAsPristine(opts?: OnlySelf)
Parameters :
Name Type Optional
opts OnlySelf Yes
Returns : void
markAsTouched
markAsTouched(opts?: OnlySelf)
Parameters :
Name Type Optional
opts OnlySelf Yes
Returns : void
markAsUntouched
markAsUntouched(opts?: OnlySelf)
Parameters :
Name Type Optional
opts OnlySelf Yes
Returns : void
patchValue
patchValue(value: T[], options?: ControlEventOptions)
Parameters :
Name Type Optional
value T[] No
options ControlEventOptions Yes
Returns : void
push
push(control: AbstractControl<T>)
Parameters :
Name Type Optional
control AbstractControl<T> No
Returns : void
reset
reset(value?: T[], options?: ControlEventOptions)
Parameters :
Name Type Optional
value T[] Yes
options ControlEventOptions Yes
Returns : void
setAsyncValidators
setAsyncValidators(newValidator: AsyncValidator)
Parameters :
Name Type Optional
newValidator AsyncValidator No
Returns : void
setControl
setControl(index: number, control: AbstractControl<T>)
Parameters :
Name Type Optional
index number No
control AbstractControl<T> No
Returns : void
setErrors
setErrors(errors: Partial | null, opts?: EmitEvent)
Parameters :
Name Type Optional
errors Partial<E> | null No
opts EmitEvent Yes
Returns : void
setValidators
setValidators(newValidator: Validator)
Parameters :
Name Type Optional
newValidator Validator No
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
value
Type T[]
import { UntypedFormArray } from '@angular/forms';

import {
  AbstractControl,
  AsyncValidator,
  ControlEventOptions,
  ControlPath,
  ControlState,
  EmitEvent,
  ExtractStrings,
  OnlySelf,
  Validator
} from './types';

/**
 * @deprecated This has been rendered obsolete by Angular 14.
 * Please use `FormArray` from `@angular/forms` instead.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export interface FormArrayTyped<T = any, E extends object = any> extends UntypedFormArray {
  readonly value: T[];
  readonly status: ControlState;
  readonly errors: E | null;

  getRawValue(): T[];

  at(index: number): AbstractControl<T>;

  setValue(value: T[], options?: ControlEventOptions): void;

  patchValue(value: T[], options?: ControlEventOptions): void;

  push(control: AbstractControl<T>): void;

  insert(index: number, control: AbstractControl<T>): void;

  setControl(index: number, control: AbstractControl<T>): void;

  markAsTouched(opts?: OnlySelf): void;

  markAsUntouched(opts?: OnlySelf): void;

  markAsPristine(opts?: OnlySelf): void;

  markAsDirty(opts?: OnlySelf): void;

  reset(value?: T[], options?: ControlEventOptions): void;
  setValidators(newValidator: Validator): void;
  setAsyncValidators(newValidator: AsyncValidator): void;

  hasError(errorCode: ExtractStrings<E>, path?: ControlPath): boolean;

  setErrors(errors: Partial<E> | null, opts?: EmitEvent): void;
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  getError<K extends ExtractStrings<E>>(errorCode: K, path?: ControlPath): any;
}

results matching ""

    No results matching ""