Permalink
Browse files

feat(forms): allow markAsPending to emit events (#20212)

closes #17958

BREAKING CHANGE:
- `AbstractControl#statusChanges` now emits an event of `'PENDING'` when you call `AbstractControl#markAsPending`
- Previously it did not emit an event when you called `markAsPending`
- To migrate you would need to ensure that if you are filtering or checking events from `statusChanges` that you account for the new event when calling `markAsPending`

PR Close #20212
  • Loading branch information...
Toxicable authored and vicb committed Nov 6, 2017
1 parent 90e9c59 commit e86b64b620c8fffbc956c4f0d61fecc6a2566caa
@@ -357,10 +357,18 @@ export abstract class AbstractControl {
/**
* Marks the control as `pending`.
*
* An event will be emitted by `statusChanges` by default.
*
* Passing `false` for `emitEvent` will cause `statusChanges` to not event an event.
*/
markAsPending(opts: {onlySelf?: boolean} = {}): void {
markAsPending(opts: {onlySelf?: boolean, emitEvent?: boolean} = {}): void {
(this as{status: string}).status = PENDING;
if (opts.emitEvent !== false) {
(this.statusChanges as EventEmitter<any>).emit(this.status);
}
if (this._parent && !opts.onlySelf) {
this._parent.markAsPending(opts);
}
@@ -622,6 +622,36 @@ import {of } from 'rxjs/observable/of';
expect(c.pending).toEqual(true);
expect(a.pending).toEqual(false);
});
describe('status change events', () => {
let logger: string[];
beforeEach(() => {
logger = [];
a.statusChanges.subscribe((status) => logger.push(status));
});
it('should emit event after marking control as pending', () => {
c.markAsPending();
expect(logger).toEqual(['PENDING']);
});
it('should not emit event from parent when onlySelf is true', () => {
c.markAsPending({onlySelf: true});
expect(logger).toEqual([]);
});
it('should not emit event when emitEvent = false', () => {
c.markAsPending({emitEvent: false});
expect(logger).toEqual([]);
});
it('should emit event when parent is markedAsPending', () => {
a.markAsPending();
expect(logger).toEqual(['PENDING']);
});
});
});
describe('valueChanges', () => {
@@ -1161,5 +1161,37 @@ import {FormArray} from '@angular/forms/src/model';
});
});
describe('pending', () => {
let c: FormControl;
beforeEach(() => { c = new FormControl('value'); });
it('should be false after creating a control', () => { expect(c.pending).toEqual(false); });
it('should be true after changing the value of the control', () => {
c.markAsPending();
expect(c.pending).toEqual(true);
});
describe('status change events', () => {
let logger: string[];
beforeEach(() => {
logger = [];
c.statusChanges.subscribe((status) => logger.push(status));
});
it('should emit event after marking control as pending', () => {
c.markAsPending();
expect(logger).toEqual(['PENDING']);
});
it('should not emit event when emitEvent = false', () => {
c.markAsPending({emitEvent: false});
expect(logger).toEqual([]);
});
});
});
});
})();
@@ -1146,6 +1146,56 @@ import {of } from 'rxjs/observable/of';
});
describe('pending', () => {
let c: FormControl;
let g: FormGroup;
beforeEach(() => {
c = new FormControl('value');
g = new FormGroup({'one': c});
});
it('should be false after creating a control', () => { expect(g.pending).toEqual(false); });
it('should be true after changing the value of the control', () => {
c.markAsPending();
expect(g.pending).toEqual(true);
});
it('should not update the parent when onlySelf = true', () => {
c.markAsPending({onlySelf: true});
expect(g.pending).toEqual(false);
});
describe('status change events', () => {
let logger: string[];
beforeEach(() => {
logger = [];
g.statusChanges.subscribe((status) => logger.push(status));
});
it('should emit event after marking control as pending', () => {
c.markAsPending();
expect(logger).toEqual(['PENDING']);
});
it('should not emit event when onlySelf = true', () => {
c.markAsPending({onlySelf: true});
expect(logger).toEqual([]);
});
it('should not emit event when emitEvent = false', () => {
c.markAsPending({emitEvent: false});
expect(logger).toEqual([]);
});
it('should emit event when parent is markedAsPending', () => {
g.markAsPending();
expect(logger).toEqual(['PENDING']);
});
});
});
});
})();
@@ -38,6 +38,7 @@ export declare abstract class AbstractControl {
}): void;
markAsPending(opts?: {
onlySelf?: boolean;
emitEvent?: boolean;
}): void;
markAsPristine(opts?: {
onlySelf?: boolean;

0 comments on commit e86b64b

Please sign in to comment.