/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ /// import {Subject, Subscription} from 'rxjs'; /** * Use in components with the `@Output` directive to emit custom events * synchronously or asynchronously, and register handlers for those events * by subscribing to an instance. * * @usageNotes * * Extends * [RxJS `Subject`](https://rxjs.dev/api/index/class/Subject) * for Angular by adding the `emit()` method. * * In the following example, a component defines two output properties * that create event emitters. When the title is clicked, the emitter * emits an open or close event to toggle the current visibility state. * * ```html * @Component({ * selector: 'zippy', * template: ` *
*
Toggle
*
* *
*
`}) * export class Zippy { * visible: boolean = true; * @Output() open: EventEmitter = new EventEmitter(); * @Output() close: EventEmitter = new EventEmitter(); * * toggle() { * this.visible = !this.visible; * if (this.visible) { * this.open.emit(null); * } else { * this.close.emit(null); * } * } * } * ``` * * Access the event object with the `$event` argument passed to the output event * handler: * * ```html * * ``` * * @see [Observables in Angular](guide/observables-in-angular) * @publicApi */ export class EventEmitter extends Subject { /** * @internal */ __isAsync: boolean; // tslint:disable-line /** * Creates an instance of this class that can * deliver events synchronously or asynchronously. * * @param isAsync When true, deliver events asynchronously. * */ constructor(isAsync: boolean = false) { super(); this.__isAsync = isAsync; } /** * Emits an event containing a given value. * @param value The value to emit. */ emit(value?: T) { super.next(value); } /** * Registers handlers for events emitted by this instance. * @param generatorOrNext When supplied, a custom handler for emitted events. * @param error When supplied, a custom handler for an error notification * from this emitter. * @param complete When supplied, a custom handler for a completion * notification from this emitter. */ subscribe(generatorOrNext?: any, error?: any, complete?: any): Subscription { let schedulerFn: (t: any) => any; let errorFn = (err: any): any => null; let completeFn = (): any => null; if (generatorOrNext && typeof generatorOrNext === 'object') { schedulerFn = this.__isAsync ? (value: any) => { setTimeout(() => generatorOrNext.next(value)); } : (value: any) => { generatorOrNext.next(value); }; if (generatorOrNext.error) { errorFn = this.__isAsync ? (err) => { setTimeout(() => generatorOrNext.error(err)); } : (err) => { generatorOrNext.error(err); }; } if (generatorOrNext.complete) { completeFn = this.__isAsync ? () => { setTimeout(() => generatorOrNext.complete()); } : () => { generatorOrNext.complete(); }; } } else { schedulerFn = this.__isAsync ? (value: any) => { setTimeout(() => generatorOrNext(value)); } : (value: any) => { generatorOrNext(value); }; if (error) { errorFn = this.__isAsync ? (err) => { setTimeout(() => error(err)); } : (err) => { error(err); }; } if (complete) { completeFn = this.__isAsync ? () => { setTimeout(() => complete()); } : () => { complete(); }; } } const sink = super.subscribe(schedulerFn, errorFn, completeFn); if (generatorOrNext instanceof Subscription) { generatorOrNext.add(sink); } return sink; } }