import { isFunction } from './util/isFunction'; import { Observer, PartialObserver } from './Observer'; import { Subscription } from './Subscription'; import { empty as emptyObserver } from './Observer'; import { rxSubscriber as rxSubscriberSymbol } from './symbol/rxSubscriber'; /** * Implements the {@link Observer} interface and extends the * {@link Subscription} class. While the {@link Observer} is the public API for * consuming the values of an {@link Observable}, all Observers get converted to * a Subscriber, in order to provide Subscription-like capabilities such as * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for * implementing operators, but it is rarely used as a public API. * * @class Subscriber */ export class Subscriber extends Subscription implements Observer { [rxSubscriberSymbol]() { return this; } /** * A static factory for a Subscriber, given a (potentially partial) definition * of an Observer. * @param {function(x: ?T): void} [next] The `next` callback of an Observer. * @param {function(e: ?any): void} [error] The `error` callback of an * Observer. * @param {function(): void} [complete] The `complete` callback of an * Observer. * @return {Subscriber} A Subscriber wrapping the (partially defined) * Observer represented by the given arguments. */ static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber { const subscriber = new Subscriber(next, error, complete); subscriber.syncErrorThrowable = false; return subscriber; } public syncErrorValue: any = null; public syncErrorThrown: boolean = false; public syncErrorThrowable: boolean = false; protected isStopped: boolean = false; protected destination: PartialObserver; // this `any` is the escape hatch to erase extra type param (e.g. R) /** * @param {Observer|function(value: T): void} [destinationOrNext] A partially * defined Observer or a `next` callback function. * @param {function(e: ?any): void} [error] The `error` callback of an * Observer. * @param {function(): void} [complete] The `complete` callback of an * Observer. */ constructor(destinationOrNext?: PartialObserver | ((value: T) => void), error?: (e?: any) => void, complete?: () => void) { super(); switch (arguments.length) { case 0: this.destination = emptyObserver; break; case 1: if (!destinationOrNext) { this.destination = emptyObserver; break; } if (typeof destinationOrNext === 'object') { // HACK(benlesh): To resolve an issue where Node users may have multiple // copies of rxjs in their node_modules directory. if (isTrustedSubscriber(destinationOrNext)) { const trustedSubscriber = destinationOrNext[rxSubscriberSymbol]() as Subscriber; this.syncErrorThrowable = trustedSubscriber.syncErrorThrowable; this.destination = trustedSubscriber; trustedSubscriber.add(this); } else { this.syncErrorThrowable = true; this.destination = new SafeSubscriber(this, > destinationOrNext); } break; } default: this.syncErrorThrowable = true; this.destination = new SafeSubscriber(this, <((value: T) => void)> destinationOrNext, error, complete); break; } } /** * The {@link Observer} callback to receive notifications of type `next` from * the Observable, with a value. The Observable may call this method 0 or more * times. * @param {T} [value] The `next` value. * @return {void} */ next(value?: T): void { if (!this.isStopped) { this._next(value); } } /** * The {@link Observer} callback to receive notifications of type `error` from * the Observable, with an attached {@link Error}. Notifies the Observer that * the Observable has experienced an error condition. * @param {any} [err] The `error` exception. * @return {void} */ error(err?: any): void { if (!this.isStopped) { this.isStopped = true; this._error(err); } } /** * The {@link Observer} callback to receive a valueless notification of type * `complete` from the Observable. Notifies the Observer that the Observable * has finished sending push-based notifications. * @return {void} */ complete(): void { if (!this.isStopped) { this.isStopped = true; this._complete(); } } unsubscribe(): void { if (this.closed) { return; } this.isStopped = true; super.unsubscribe(); } protected _next(value: T): void { this.destination.next(value); } protected _error(err: any): void { this.destination.error(err); this.unsubscribe(); } protected _complete(): void { this.destination.complete(); this.unsubscribe(); } /** @deprecated internal use only */ _unsubscribeAndRecycle(): Subscriber { const { _parent, _parents } = this; this._parent = null; this._parents = null; this.unsubscribe(); this.closed = false; this.isStopped = false; this._parent = _parent; this._parents = _parents; return this; } } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ class SafeSubscriber extends Subscriber { private _context: any; constructor(private _parentSubscriber: Subscriber, observerOrNext?: PartialObserver | ((value: T) => void), error?: (e?: any) => void, complete?: () => void) { super(); let next: ((value: T) => void); let context: any = this; if (isFunction(observerOrNext)) { next = (<((value: T) => void)> observerOrNext); } else if (observerOrNext) { next = (> observerOrNext).next; error = (> observerOrNext).error; complete = (> observerOrNext).complete; if (observerOrNext !== emptyObserver) { context = Object.create(observerOrNext); if (isFunction(context.unsubscribe)) { this.add(<() => void> context.unsubscribe.bind(context)); } context.unsubscribe = this.unsubscribe.bind(this); } } this._context = context; this._next = next; this._error = error; this._complete = complete; } next(value?: T): void { if (!this.isStopped && this._next) { const { _parentSubscriber } = this; if (!_parentSubscriber.syncErrorThrowable) { this.__tryOrUnsub(this._next, value); } else if (this.__tryOrSetError(_parentSubscriber, this._next, value)) { this.unsubscribe(); } } } error(err?: any): void { if (!this.isStopped) { const { _parentSubscriber } = this; if (this._error) { if (!_parentSubscriber.syncErrorThrowable) { this.__tryOrUnsub(this._error, err); this.unsubscribe(); } else { this.__tryOrSetError(_parentSubscriber, this._error, err); this.unsubscribe(); } } else if (!_parentSubscriber.syncErrorThrowable) { this.unsubscribe(); throw err; } else { _parentSubscriber.syncErrorValue = err; _parentSubscriber.syncErrorThrown = true; this.unsubscribe(); } } } complete(): void { if (!this.isStopped) { const { _parentSubscriber } = this; if (this._complete) { const wrappedComplete = () => this._complete.call(this._context); if (!_parentSubscriber.syncErrorThrowable) { this.__tryOrUnsub(wrappedComplete); this.unsubscribe(); } else { this.__tryOrSetError(_parentSubscriber, wrappedComplete); this.unsubscribe(); } } else { this.unsubscribe(); } } } private __tryOrUnsub(fn: Function, value?: any): void { try { fn.call(this._context, value); } catch (err) { this.unsubscribe(); throw err; } } private __tryOrSetError(parent: Subscriber, fn: Function, value?: any): boolean { try { fn.call(this._context, value); } catch (err) { parent.syncErrorValue = err; parent.syncErrorThrown = true; return true; } return false; } /** @deprecated internal use only */ _unsubscribe(): void { const { _parentSubscriber } = this; this._context = null; this._parentSubscriber = null; _parentSubscriber.unsubscribe(); } } function isTrustedSubscriber(obj: any) { return obj instanceof Subscriber || ('syncErrorThrowable' in obj && obj[rxSubscriberSymbol]); }