import { ConnectableObservable } from '../observable/ConnectableObservable'; import { Subscription } from '../Subscription'; import { MonoTypeOperatorFunction } from '../types'; import { operate } from '../util/lift'; import { createOperatorSubscriber } from './OperatorSubscriber'; /** * Make a {@link ConnectableObservable} behave like a ordinary observable and automates the way * you can connect to it. * * Internally it counts the subscriptions to the observable and subscribes (only once) to the source if * the number of subscriptions is larger than 0. If the number of subscriptions is smaller than 1, it * unsubscribes from the source. This way you can make sure that everything before the *published* * refCount has only a single subscription independently of the number of subscribers to the target * observable. * * Note that using the {@link share} operator is exactly the same as using the `multicast(() => new Subject())` operator * (making the observable hot) and the *refCount* operator in a sequence. * * ![](refCount.png) * * ## Example * * In the following example there are two intervals turned into connectable observables * by using the *publish* operator. The first one uses the *refCount* operator, the * second one does not use it. You will notice that a connectable observable does nothing * until you call its connect function. * * ```ts * import { interval, tap, publish, refCount } from 'rxjs'; * * // Turn the interval observable into a ConnectableObservable (hot) * const refCountInterval = interval(400).pipe( * tap(num => console.log(`refCount ${ num }`)), * publish(), * refCount() * ); * * const publishedInterval = interval(400).pipe( * tap(num => console.log(`publish ${ num }`)), * publish() * ); * * refCountInterval.subscribe(); * refCountInterval.subscribe(); * // 'refCount 0' -----> 'refCount 1' -----> etc * // All subscriptions will receive the same value and the tap (and * // every other operator) before the `publish` operator will be executed * // only once per event independently of the number of subscriptions. * * publishedInterval.subscribe(); * // Nothing happens until you call .connect() on the observable. * ``` * * @return A function that returns an Observable that automates the connection * to ConnectableObservable. * @see {@link ConnectableObservable} * @see {@link share} * @see {@link publish} * @deprecated Replaced with the {@link share} operator. How `share` is used * will depend on the connectable observable you created just prior to the * `refCount` operator. * Details: https://rxjs.dev/deprecations/multicasting */ export function refCount(): MonoTypeOperatorFunction { return operate((source, subscriber) => { let connection: Subscription | null = null; (source as any)._refCount++; const refCounter = createOperatorSubscriber(subscriber, undefined, undefined, undefined, () => { if (!source || (source as any)._refCount <= 0 || 0 < --(source as any)._refCount) { connection = null; return; } /// // Compare the local RefCountSubscriber's connection Subscription to the // connection Subscription on the shared ConnectableObservable. In cases // where the ConnectableObservable source synchronously emits values, and // the RefCountSubscriber's downstream Observers synchronously unsubscribe, // execution continues to here before the RefCountOperator has a chance to // supply the RefCountSubscriber with the shared connection Subscription. // For example: // ``` // range(0, 10).pipe( // publish(), // refCount(), // take(5), // ) // .subscribe(); // ``` // In order to account for this case, RefCountSubscriber should only dispose // the ConnectableObservable's shared connection Subscription if the // connection Subscription exists, *and* either: // a. RefCountSubscriber doesn't have a reference to the shared connection // Subscription yet, or, // b. RefCountSubscriber's connection Subscription reference is identical // to the shared connection Subscription /// const sharedConnection = (source as any)._connection; const conn = connection; connection = null; if (sharedConnection && (!conn || sharedConnection === conn)) { sharedConnection.unsubscribe(); } subscriber.unsubscribe(); }); source.subscribe(refCounter); if (!refCounter.closed) { connection = (source as ConnectableObservable).connect(); } }); }