File

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

Deprecated

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

Description

Please use FormControl from @angular/forms instead.

Extends

UntypedFormControl

Index

Properties
Methods

Methods

getError
getError(errorCode: K)
Type parameters :
  • K
Parameters :
Name Type Optional
errorCode K No
Returns : | null
hasError
hasError(errorCode: K)
Type parameters :
  • K
Parameters :
Name Type Optional
errorCode K No
Returns : boolean
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?: ControlOptions)
Parameters :
Name Type Optional
value T No
options ControlOptions Yes
Returns : void
reset
reset(formState?: OrBoxedValue<T>, options?: ControlEventOptions)
Parameters :
Name Type Optional
formState OrBoxedValue<T> Yes
options ControlEventOptions Yes
Returns : void
setAsyncValidators
setAsyncValidators(newValidator: AsyncValidator)
Parameters :
Name Type Optional
newValidator AsyncValidator 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?: ControlOptions)
Parameters :
Name Type Optional
value T No
options ControlOptions Yes
Returns : void

Properties

asyncValidator
Type AsyncValidatorFn<T>
errors
Type E | null
status
Type ControlState
statusChanges
Type Observable<ControlState>
value
Type T
valueChanges
Type Observable<T>
import { UntypedFormControl } from '@angular/forms';
import { Observable } from 'rxjs';

import {
  AsyncValidator,
  AsyncValidatorFn,
  ControlEventOptions,
  ControlOptions,
  ControlState,
  EmitEvent,
  ExtractStrings,
  OnlySelf,
  OrBoxedValue,
  Validator
} from './types';

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

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

  setValue(value: T, options?: ControlOptions): void;
  patchValue(value: T, options?: ControlOptions): void;
  markAsTouched(opts?: OnlySelf): void;
  markAsUntouched(opts?: OnlySelf): void;
  markAsPristine(opts?: OnlySelf): void;
  markAsDirty(opts?: OnlySelf): void;

  reset(formState?: OrBoxedValue<T>, options?: ControlEventOptions): void;

  setValidators(newValidator: Validator): void;

  setAsyncValidators(newValidator: AsyncValidator): void;

  getError<K extends ExtractStrings<E>>(errorCode: K): E[K] | null;
  hasError<K extends ExtractStrings<E>>(errorCode: K): boolean;
  setErrors(errors: Partial<E> | null, opts?: EmitEvent): void;
}

results matching ""

    No results matching ""