angular/packages/forms/src/model/abstract_model.ts at main · angular/angular · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

/**

* @license

* Use of this source code is governed by an MIT-style license that can be

* found in the LICENSE file at https://angular.dev/license

import {

computed,

EventEmitter,

ɵRuntimeError as RuntimeError,

signal,

untracked,

ɵWritable as Writable,

} from '@angular/core';

import {Observable, Subject, Subscription} from 'rxjs';

import {

asyncValidatorsDroppedWithOptsWarning,

missingControlError,

missingControlValueError,

noControlsError,

} from '../directives/reactive_errors';

import type {AsyncValidatorFn, ValidationErrors, ValidatorFn} from '../directives/validators';

import {RuntimeErrorCode} from '../errors';

import {

addValidators,

composeAsyncValidators,

composeValidators,

hasValidator,

removeValidators,

toObservable,

Validators,

} from '../validators';

import type {FormArray} from './form_array';

import type {FormGroup} from './form_group';

/**

* Reports that a control is valid, meaning that no errors exist in the input value.

* @see {@link status}

export const VALID = 'VALID';

/**

* Reports that a control is invalid, meaning that an error exists in the input value.

* @see {@link status}

export const INVALID = 'INVALID';

/**

* Reports that a control is pending, meaning that async validation is occurring and

* errors are not yet available for the input value.

* @see {@link markAsPending}

* @see {@link status}

export const PENDING = 'PENDING';

/**

* Reports that a control is disabled, meaning that the control is exempt from ancestor

* calculations of validity or value.

* @see {@link markAsDisabled}

* @see {@link status}

export const DISABLED = 'DISABLED';

/**

* A form can have several different statuses. Each

* possible status is returned as a string literal.

* * **VALID**: Reports that a control is valid, meaning that no errors exist in the input

* value.

* * **INVALID**: Reports that a control is invalid, meaning that an error exists in the input

* value.

* * **PENDING**: Reports that a control is pending, meaning that async validation is

* occurring and errors are not yet available for the input value.

* * **DISABLED**: Reports that a control is

* disabled, meaning that the control is exempt from ancestor calculations of validity or value.

* @publicApi

export type FormControlStatus = 'VALID' | 'INVALID' | 'PENDING' | 'DISABLED';

/**

* Base class for every event sent by `AbstractControl.events()`

* @publicApi

export abstract class ControlEvent<T = any> {

/**

* Form control from which this event is originated.

* Note: the type of the control can't be infered from T as the event can be emitted by any of child controls

public abstract readonly source: AbstractControl<unknown>;

}

/**

* Event fired when the value of a control changes.

* @see {@link AbstractControl.events}

* @publicApi

export class ValueChangeEvent<T> extends ControlEvent<T> {

constructor(

public readonly value: T,

public readonly source: AbstractControl,

) {

super();

}

/**

* Event fired when the control's pristine state changes (pristine <=> dirty).

* @see {@link AbstractControl.events}

* @publicApi */

export class PristineChangeEvent extends ControlEvent {

constructor(

public readonly pristine: boolean,

public readonly source: AbstractControl,

) {

super();

}

/**

* Event fired when the control's touched status changes (touched <=> untouched).

* @see {@link AbstractControl.events}

* @publicApi

export class TouchedChangeEvent extends ControlEvent {

constructor(

public readonly touched: boolean,

public readonly source: AbstractControl,

) {

super();

}

/**

* Event fired when the control's status changes.

* @see {@link AbstractControl.events}

* @publicApi

export class StatusChangeEvent extends ControlEvent {

constructor(

public readonly status: FormControlStatus,

public readonly source: AbstractControl,

) {

super();

}

/**

* Event fired when a form is submitted

* @see {@link AbstractControl.events}

* @publicApi

export class FormSubmittedEvent extends ControlEvent {

constructor(public readonly source: AbstractControl) {

super();

}

/**

* Event fired when a form is reset.

* @see {@link AbstractControl.events}

* @publicApi

export class FormResetEvent extends ControlEvent {

constructor(public readonly source: AbstractControl) {

super();

}

/**

* Gets validators from either an options object or given validators.

export function pickValidators(

validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null,

): ValidatorFn | ValidatorFn[] | null {

return (isOptionsObj(validatorOrOpts) ? validatorOrOpts.validators : validatorOrOpts) || null;

}

/**

* Creates validator function by combining provided validators.

function coerceToValidator(validator: ValidatorFn | ValidatorFn[] | null): ValidatorFn | null {

return Array.isArray(validator) ? composeValidators(validator) : validator || null;

}

/**

* Gets async validators from either an options object or given validators.

export function pickAsyncValidators(

asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null,

validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null,

): AsyncValidatorFn | AsyncValidatorFn[] | null {

if (typeof ngDevMode === 'undefined' || ngDevMode) {

if (isOptionsObj(validatorOrOpts) && asyncValidator) {

console.warn(asyncValidatorsDroppedWithOptsWarning);

}

return (isOptionsObj(validatorOrOpts) ? validatorOrOpts.asyncValidators : asyncValidator) || null;

}

/**

* Creates async validator function by combining provided async validators.

function coerceToAsyncValidator(

asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null,

): AsyncValidatorFn | null {

return Array.isArray(asyncValidator)

? composeAsyncValidators(asyncValidator)

: asyncValidator || null;

}

export type FormHooks = 'change' | 'blur' | 'submit';

/**

* Interface for options provided to an `AbstractControl`.

* @publicApi

export interface AbstractControlOptions {

/**

* @description

* The list of validators applied to a control.

validators?: ValidatorFn | ValidatorFn[] | null;

/**

* @description

* The list of async validators applied to control.

asyncValidators?: AsyncValidatorFn | AsyncValidatorFn[] | null;

/**

* @description

* The event name for control to update upon.

updateOn?: 'change' | 'blur' | 'submit';

}

export function isOptionsObj(

validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null,

): validatorOrOpts is AbstractControlOptions {

return (

validatorOrOpts != null &&

!Array.isArray(validatorOrOpts) &&

typeof validatorOrOpts === 'object'

);

}

export function assertControlPresent(parent: any, isGroup: boolean, key: string | number): void {

const controls = parent.controls as {[key: string | number]: AbstractControl<any>};

const collection = isGroup ? Object.keys(controls) : controls;

if (!collection.length) {

throw new RuntimeError(

RuntimeErrorCode.NO_CONTROLS,

typeof ngDevMode === 'undefined' || ngDevMode ? noControlsError(isGroup) : '',

);

}

if (!hasOwnControl(controls, key)) {

throw new RuntimeError(

RuntimeErrorCode.MISSING_CONTROL,

typeof ngDevMode === 'undefined' || ngDevMode ? missingControlError(isGroup, key) : '',

);

}

export function assertAllValuesPresent(control: any, isGroup: boolean, value: any): void {

control._forEachChild((_: unknown, key: string | number) => {

if (value[key] === undefined) {

throw new RuntimeError(

RuntimeErrorCode.MISSING_CONTROL_VALUE,

typeof ngDevMode === 'undefined' || ngDevMode ? missingControlValueError(isGroup, key) : '',

);

}

});

}

// IsAny checks if T is `any`, by checking a condition that couldn't possibly be true otherwise.

export type ɵIsAny<T, Y, N> = 0 extends 1 & T ? Y : N;

/**

* `TypedOrUntyped` allows one of two different types to be selected, depending on whether the Forms

* class it's applied to is typed or not.

* This is for internal Angular usage to support typed forms; do not directly use it.

export type ɵTypedOrUntyped<T, Typed, Untyped> = ɵIsAny<T, Untyped, Typed>;

/**

* Value gives the value type corresponding to a control type.

* Note that the resulting type will follow the same rules as `.value` on your control, group, or

* array, including `undefined` for each group element which might be disabled.

* If you are trying to extract a value type for a data model, you probably want {@link RawValue},

* which will not have `undefined` in group keys.

* @usageNotes

* ### `FormControl` value type

* You can extract the value type of a single control:

* ```ts

* type NameControl = FormControl<string>;

* type NameValue = Value<NameControl>;

* ```

* The resulting type is `string`.

* ### `FormGroup` value type

* Imagine you have an interface defining the controls in your group. You can extract the shape of

* the values as follows:

* ```ts

* interface PartyFormControls {

* address: FormControl<string>;

* }

* // Value operates on controls; the object must be wrapped in a FormGroup.

* type PartyFormValues = Value<FormGroup<PartyFormControls>>;

* ```

* The resulting type is `{address: string|undefined}`.

* ### `FormArray` value type

* You can extract values from FormArrays as well:

* ```ts

* type GuestNamesControls = FormArray<FormControl<string>>;

* type NamesValues = Value<GuestNamesControls>;

* ```

* The resulting type is `string[]`.

* **Internal: not for public use.**

export type ɵValue<T extends AbstractControl | undefined> =

T extends AbstractControl<any, any> ? T['value'] : never;

/**

* RawValue gives the raw value type corresponding to a control type.

* Note that the resulting type will follow the same rules as `.getRawValue()` on your control,

* group, or array. This means that all controls inside a group will be required, not optional,

* regardless of their disabled state.

* You may also wish to use {@link ɵValue}, which will have `undefined` in group keys (which can be

* disabled).

* @usageNotes

* ### `FormGroup` raw value type

* Imagine you have an interface defining the controls in your group. You can extract the shape of

* the raw values as follows:

* ```ts

* interface PartyFormControls {

* address: FormControl<string>;

* }

* // RawValue operates on controls; the object must be wrapped in a FormGroup.

* type PartyFormValues = RawValue<FormGroup<PartyFormControls>>;

* ```

* The resulting type is `{address: string}`. (Note the absence of `undefined`.)

* **Internal: not for public use.**

export type ɵRawValue<T extends AbstractControl | undefined> =

T extends AbstractControl<any, any>

? T['setValue'] extends (v: infer R) => void

? R

: never

: never;

/**

* Tokenize splits a string literal S by a delimiter D.

export type ɵTokenize<S extends string, D extends string> = string extends S

? string[] /* S must be a literal */

: S extends `${infer T}${D}${infer U}`

? [T, ...ɵTokenize<U, D>]

: [S]; /* Base case */

/**

* CoerceStrArrToNumArr accepts an array of strings, and converts any numeric string to a number.

export type ɵCoerceStrArrToNumArr<S> =

// Extract the head of the array.

S extends [infer Head, ...infer Tail]

? // Using a template literal type, coerce the head to `number` if possible.

// Then, recurse on the tail.

Head extends `${number}`

? [number, ...ɵCoerceStrArrToNumArr<Tail>]

: [Head, ...ɵCoerceStrArrToNumArr<Tail>]

: [];

/**

* Navigate takes a type T and an array K, and returns the type of T[K[0]][K[1]][K[2]]...

export type ɵNavigate<

K extends Array<string | number>,

> = T extends object /* T must be indexable (object or array) */

? K extends [infer Head, ...infer Tail] /* Split K into head and tail */

? Head extends keyof T /* head(K) must index T */

? Tail extends (string | number)[] /* tail(K) must be an array */

? [] extends Tail

? T[Head] /* base case: K can be split, but Tail is empty */

: ɵNavigate<T[Head], Tail> /* explore T[head(K)] by tail(K) */

: any /* tail(K) was not an array, give up */

: never /* head(K) does not index T, give up */

: any /* K cannot be split, give up */

: any; /* T is not indexable, give up */

/**

* ɵWriteable removes readonly from all keys.

export type ɵWriteable<T> = {

-readonly [P in keyof T]: T[P];

};

/**

* GetProperty takes a type T and some property names or indices K.

* If K is a dot-separated string, it is tokenized into an array before proceeding.

* Then, the type of the nested property at K is computed: T[K[0]][K[1]][K[2]]...

* This works with both objects, which are indexed by property name, and arrays, which are indexed

* numerically.

* For internal use only.

export type ɵGetProperty<T, K> =

// K is a string

K extends string

? ɵGetProperty<T, ɵCoerceStrArrToNumArr<ɵTokenize<K, '.'>>>

: // Is it an array

ɵWriteable<K> extends Array<string | number>

? ɵNavigate<T, ɵWriteable<K>>

: // Fall through permissively if we can't calculate the type of K.

any;

/**

* This is the base class for `FormControl`, `FormGroup`, and `FormArray`.

* It provides some of the shared behavior that all controls and groups of controls have, like

* running validators, calculating status, and resetting state. It also defines the properties

* that are shared between all sub-classes, like `value`, `valid`, and `dirty`. It shouldn't be

* instantiated directly.

* The first type parameter TValue represents the value type of the control (`control.value`).

* The optional type parameter TRawValue represents the raw value type (`control.getRawValue()`).

* @see [Forms Guide](guide/forms)

* @see [Reactive Forms Guide](guide/forms/reactive-forms)

* @see [Dynamic Forms Guide](guide/forms/dynamic-forms)

* @publicApi

export abstract class AbstractControl<

TValue = any,

TRawValue extends TValue = TValue,

TValueWithOptionalControlStates = any,

> {

/** @internal */

_pendingDirty = false;

/**

* Indicates that a control has its own pending asynchronous validation in progress.

* It also stores if the control should emit events when the validation status changes.

* @internal

_hasOwnPendingAsyncValidator: null | {emitEvent: boolean; shouldHaveEmitted: boolean} = null;

/** @internal */

_pendingTouched = false;

/** @internal */

_onCollectionChange = () => {};

/** @internal */

_updateOn?: FormHooks;

/** @internal */

_hasRequired = signal(false);

private _parent: FormGroup | FormArray | null = null;

private _asyncValidationSubscription: Subscription | undefined;

/**

* Contains the result of merging synchronous validators into a single validator function

* (combined using `Validators.compose`).

* @internal

private _composedValidatorFn!: ValidatorFn | null;

/**

* Contains the result of merging asynchronous validators into a single validator function

* (combined using `Validators.composeAsync`).

* @internal

private _composedAsyncValidatorFn!: AsyncValidatorFn | null;

/**

* Synchronous validators as they were provided:

* - in `AbstractControl` constructor

* - as an argument while calling `setValidators` function

* - while calling the setter on the `validator` field (e.g. `control.validator = validatorFn`)

* @internal

private _rawValidators!: ValidatorFn | ValidatorFn[] | null;

/**

* Asynchronous validators as they were provided:

* - in `AbstractControl` constructor

* - as an argument while calling `setAsyncValidators` function

* - while calling the setter on the `asyncValidator` field (e.g. `control.asyncValidator =

* asyncValidatorFn`)

* @internal

private _rawAsyncValidators!: AsyncValidatorFn | AsyncValidatorFn[] | null;

/**

* The current value of the control.

* * For a `FormControl`, the current value.

* * For an enabled `FormGroup`, the values of enabled controls as an object

* with a key-value pair for each member of the group.

* * For a disabled `FormGroup`, the values of all controls as an object

* with a key-value pair for each member of the group.

* * For an enabled `FormArray`, the values of enabled controls as an array.

* * For a disabled `FormArray`, the values of all controls as an array.

public readonly value!: TValue;

/**

* Initialize the AbstractControl instance.

* @param validators The function or array of functions that is used to determine the validity of

* this control synchronously.

* @param asyncValidators The function or array of functions that is used to determine validity of

* this control asynchronously.

constructor(

validators: ValidatorFn | ValidatorFn[] | null,

asyncValidators: AsyncValidatorFn | AsyncValidatorFn[] | null,

) {

this._assignValidators(validators);

this._assignAsyncValidators(asyncValidators);

}

/**

* Returns the function that is used to determine the validity of this control synchronously.

* If multiple validators have been added, this will be a single composed function.

* See `Validators.compose()` for additional information.

get validator(): ValidatorFn | null {

return this._composedValidatorFn;

}

set validator(validatorFn: ValidatorFn | null) {

this._rawValidators = this._composedValidatorFn = validatorFn;

this._updateHasRequiredValidator();

}

/**

* Returns the function that is used to determine the validity of this control asynchronously.

* If multiple validators have been added, this will be a single composed function.

* See `Validators.compose()` for additional information.

get asyncValidator(): AsyncValidatorFn | null {

return this._composedAsyncValidatorFn;

}

set asyncValidator(asyncValidatorFn: AsyncValidatorFn | null) {

this._rawAsyncValidators = this._composedAsyncValidatorFn = asyncValidatorFn;

}

/**

* The parent control.

get parent(): FormGroup | FormArray | null {

return this._parent;

}

/**

* The validation status of the control.

* @see {@link FormControlStatus}

* These status values are mutually exclusive, so a control cannot be

* both valid AND invalid or invalid AND disabled.

get status(): FormControlStatus {

return untracked(this.statusReactive)!;

}

private set status(v: FormControlStatus) {

untracked(() => this.statusReactive.set(v));

}

/** @internal */

readonly _status = computed(() => this.statusReactive());

private readonly statusReactive = signal<FormControlStatus | undefined>(undefined);

/**

* A control is `valid` when its `status` is `VALID`.

* @see {@link AbstractControl.status}

* @returns True if the control has passed all of its validation tests,

* false otherwise.

get valid(): boolean {

return this.status === VALID;

}

/**

* A control is `invalid` when its `status` is `INVALID`.

* @see {@link AbstractControl.status}

* @returns True if this control has failed one or more of its validation checks,

* false otherwise.

get invalid(): boolean {

return this.status === INVALID;

}

/**

* A control is `pending` when its `status` is `PENDING`.

* @see {@link AbstractControl.status}

* @returns True if this control is in the process of conducting a validation check,

* false otherwise.

get pending(): boolean {

return this.status === PENDING;

}

/**

* A control is `disabled` when its `status` is `DISABLED`.

* Disabled controls are exempt from validation checks and

* are not included in the aggregate value of their ancestor

* controls.

* @see {@link AbstractControl.status}

* @returns True if the control is disabled, false otherwise.

get disabled(): boolean {

return this.status === DISABLED;

}

/**

* A control is `enabled` as long as its `status` is not `DISABLED`.

* @returns True if the control has any status other than 'DISABLED',

* false if the status is 'DISABLED'.

* @see {@link AbstractControl.status}

get enabled(): boolean {

return this.status !== DISABLED;

}

/**

* An object containing any errors generated by failing validation,

* or null if there are no errors.

public readonly errors!: ValidationErrors | null;

/**

* A control is `pristine` if the user has not yet changed

* the value in the UI.

* @returns True if the user has not yet changed the value in the UI; compare `dirty`.

* Programmatic changes to a control's value do not mark it dirty.

get pristine(): boolean {

return untracked(this.pristineReactive);

}

private set pristine(v: boolean) {

untracked(() => this.pristineReactive.set(v));

}

/** @internal */

readonly _pristine = computed(() => this.pristineReactive());

private readonly pristineReactive = signal(true);

/**

* A control is `dirty` if the user has changed the value

* in the UI.

* @returns True if the user has changed the value of this control in the UI; compare `pristine`.

* Programmatic changes to a control's value do not mark it dirty.

get dirty(): boolean {

return !this.pristine;

}

/**

* True if the control is marked as `touched`.

* A control is marked `touched` once the user has triggered

* a `blur` event on it.

get touched(): boolean {

return untracked(this.touchedReactive);

}

private set touched(v: boolean) {

untracked(() => this.touchedReactive.set(v));

}

/** @internal */

readonly _touched = computed(() => this.touchedReactive());

private readonly touchedReactive = signal(false);

/**

* True if the control has not been marked as touched

* A control is `untouched` if the user has not yet triggered

* a `blur` event on it.

get untouched(): boolean {

return !this.touched;

}

/**

* Exposed as observable, see below.

* @internal

readonly _events = new Subject<ControlEvent<TValue>>();

/**

* A multicasting observable that emits an event every time the state of the control changes.

* It emits for value, status, pristine or touched changes.

* **Note**: On value change, the emit happens right after a value of this control is updated. The

* value of a parent control (for example if this FormControl is a part of a FormGroup) is updated

* later, so accessing a value of a parent control (using the `value` property) from the callback

* of this event might result in getting a value that has not been updated yet. Subscribe to the

* `events` of the parent control instead.

* For other event types, the events are emitted after the parent control has been updated.

* @see [Unified control state change events](guide/forms/reactive-forms#unified-control-state-change-events)

public readonly events = this._events.asObservable();

/**

* A multicasting observable that emits an event every time the value of the control changes, in

* the UI or programmatically. It also emits an event each time you call enable() or disable()

* without passing along {emitEvent: false} as a function argument.

* **Note**: the emit happens right after a value of this control is updated. The value of a

* parent control (for example if this FormControl is a part of a FormGroup) is updated later, so

* accessing a value of a parent control (using the `value` property) from the callback of this

* event might result in getting a value that has not been updated yet. Subscribe to the

* `valueChanges` event of the parent control instead.

public readonly valueChanges!: Observable<TValue>;

/**

* A multicasting observable that emits an event every time the validation `status` of the control

* recalculates.

* @see {@link FormControlStatus}

* @see {@link AbstractControl.status}

public readonly statusChanges!: Observable<FormControlStatus>;

/**

* Reports the update strategy of the `AbstractControl` (meaning

* the event on which the control updates itself).

* Possible values: `'change'` | `'blur'` | `'submit'`

* Default value: `'change'`

get updateOn(): FormHooks {

return this._updateOn ? this._updateOn : this.parent ? this.parent.updateOn : 'change';

}

/**

* Sets the synchronous validators that are active on this control. Calling

* this overwrites any existing synchronous validators.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* If you want to add a new validator without affecting existing ones, consider

* using `addValidators()` method instead.

setValidators(validators: ValidatorFn | ValidatorFn[] | null): void {

this._assignValidators(validators);

}

/**

* Sets the asynchronous validators that are active on this control. Calling this

* overwrites any existing asynchronous validators.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* If you want to add a new validator without affecting existing ones, consider

* using `addAsyncValidators()` method instead.

setAsyncValidators(validators: AsyncValidatorFn | AsyncValidatorFn[] | null): void {

this._assignAsyncValidators(validators);

}

/**

* Add a synchronous validator or validators to this control, without affecting other validators.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* Adding a validator that already exists will have no effect. If duplicate validator functions

* are present in the `validators` array, only the first instance would be added to a form

* control.

* @param validators The new validator function or functions to add to this control.

addValidators(validators: ValidatorFn | ValidatorFn[]): void {

this.setValidators(addValidators(validators, this._rawValidators));

}

/**

* Add an asynchronous validator or validators to this control, without affecting other

* validators.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* Adding a validator that already exists will have no effect.

* @param validators The new asynchronous validator function or functions to add to this control.

addAsyncValidators(validators: AsyncValidatorFn | AsyncValidatorFn[]): void {

this.setAsyncValidators(addValidators(validators, this._rawAsyncValidators));

}

/**

* Remove a synchronous validator from this control, without affecting other validators.

* Validators are compared by function reference; you must pass a reference to the exact same

* validator function as the one that was originally set. If a provided validator is not found,

* it is ignored.

* @usageNotes

* ```ts

* // Reference to the RequiredValidator

* const ctrl = new FormControl<string | null>('', Validators.required);

* ctrl.removeValidators(Validators.required);

* // Reference to anonymous function inside MinValidator

* const minValidator = Validators.min(3);

* const ctrl = new FormControl<string | null>('', minValidator);

* expect(ctrl.hasValidator(minValidator)).toEqual(true)

* expect(ctrl.hasValidator(Validators.min(3))).toEqual(false)

* ctrl.removeValidators(minValidator);

* ```

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* @param validators The validator or validators to remove.

removeValidators(validators: ValidatorFn | ValidatorFn[]): void {

this.setValidators(removeValidators(validators, this._rawValidators));

}

/**

* Remove an asynchronous validator from this control, without affecting other validators.

* Validators are compared by function reference; you must pass a reference to the exact same

* validator function as the one that was originally set. If a provided validator is not found, it

* is ignored.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

* @param validators The asynchronous validator or validators to remove.

removeAsyncValidators(validators: AsyncValidatorFn | AsyncValidatorFn[]): void {

this.setAsyncValidators(removeValidators(validators, this._rawAsyncValidators));

}

/**

* Check whether a synchronous validator function is present on this control. The provided

* validator must be a reference to the exact same function that was provided.

* @usageNotes

* ```ts

* // Reference to the RequiredValidator

* const ctrl = new FormControl<number | null>(0, Validators.required);

* expect(ctrl.hasValidator(Validators.required)).toEqual(true)

* // Reference to anonymous function inside MinValidator

* const minValidator = Validators.min(3);

* const ctrl = new FormControl<number | null>(0, minValidator);

* expect(ctrl.hasValidator(minValidator)).toEqual(true)

* expect(ctrl.hasValidator(Validators.min(3))).toEqual(false)

* ```

* @param validator The validator to check for presence. Compared by function reference.

* @returns Whether the provided validator was found on this control.

hasValidator(validator: ValidatorFn): boolean {

return hasValidator(this._rawValidators, validator);

}

/**

* Check whether an asynchronous validator function is present on this control. The provided

* validator must be a reference to the exact same function that was provided.

* @param validator The asynchronous validator to check for presence. Compared by function

* reference.

* @returns Whether the provided asynchronous validator was found on this control.

hasAsyncValidator(validator: AsyncValidatorFn): boolean {

return hasValidator(this._rawAsyncValidators, validator);

}

/**

* Empties out the synchronous validator list.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

clearValidators(): void {

this.validator = null;

}

/**

* Empties out the async validator list.

* When you add or remove a validator at run time, you must call

* `updateValueAndValidity()` for the new validation to take effect.

clearAsyncValidators(): void {

this.asyncValidator = null;

}

/**

* Marks the control as `touched`. A control is touched by focus and

* blur events that do not change the value.

* @see {@link markAsUntouched()}

* @see {@link markAsDirty()}

* @see {@link markAsPristine()}

* @param opts Configuration options that determine how the control propagates changes

* and emits events after marking is applied.

* * `onlySelf`: When true, mark only this control. When false or not supplied,

* marks all direct ancestors. Default is false.

* * `emitEvent`: When true or not supplied (the default), the `events`

* observable emits a `TouchedChangeEvent` with the `touched` property being `true`.

* When false, no events are emitted.

* @see [Managing form control state](guide/forms/reactive-forms#managing-form-control-state)

markAsTouched(opts?: {onlySelf?: boolean; emitEvent?: boolean}): void;

/**

* @internal Used to propagate the source control downwards

markAsTouched(opts?: {

onlySelf?: boolean;

emitEvent?: boolean;

sourceControl?: AbstractControl;

}): void;

markAsTouched(

opts: {onlySelf?: boolean; emitEvent?: boolean; sourceControl?: AbstractControl} = {},

View remainder of file in raw view

angular/packages/forms/src/model/abstract_model.ts at main · angular/angular · GitHub

Repository navigation

Expand file tree

Breadcrumbs

abstract_model.ts

Latest commit

History

Breadcrumbs

abstract_model.ts

File metadata and controls