import { Operator } from '../Operator'; import { Subscriber } from '../Subscriber'; import { async } from '../scheduler/async'; import { Observable } from '../Observable'; import { isDate } from '../util/isDate'; import { ObservableInput, OperatorFunction, SchedulerAction, SchedulerLike, TeardownLogic } from '../types'; import { SimpleOuterSubscriber, innerSubscribe, SimpleInnerSubscriber } from '../innerSubscribe'; /* tslint:disable:max-line-length */ export function timeoutWith<T, R>(due: number | Date, withObservable: ObservableInput<R>, scheduler?: SchedulerLike): OperatorFunction<T, T | R>; /* tslint:enable:max-line-length */ /** * * Errors if Observable does not emit a value in given time span, in case of which * subscribes to the second Observable. * * <span class="informal">It's a version of `timeout` operator that let's you specify fallback Observable.</span> * *  * * `timeoutWith` is a variation of `timeout` operator. It behaves exactly the same, * still accepting as a first argument either a number or a Date, which control - respectively - * when values of source Observable should be emitted or when it should complete. * * The only difference is that it accepts a second, required parameter. This parameter * should be an Observable which will be subscribed when source Observable fails any timeout check. * So whenever regular `timeout` would emit an error, `timeoutWith` will instead start re-emitting * values from second Observable. Note that this fallback Observable is not checked for timeouts * itself, so it can emit values and complete at arbitrary points in time. From the moment of a second * subscription, Observable returned from `timeoutWith` simply mirrors fallback stream. When that * stream completes, it completes as well. * * Scheduler, which in case of `timeout` is provided as as second argument, can be still provided * here - as a third, optional parameter. It still is used to schedule timeout checks and - * as a consequence - when second Observable will be subscribed, since subscription happens * immediately after failing check. * * ## Example * Add fallback observable * ```ts * import { interval } from 'rxjs'; * import { timeoutWith } from 'rxjs/operators'; * * const seconds = interval(1000); * const minutes = interval(60 * 1000); * * seconds.pipe(timeoutWith(900, minutes)) * .subscribe( * value => console.log(value), // After 900ms, will start emitting `minutes`, * // since first value of `seconds` will not arrive fast enough. * err => console.log(err), // Would be called after 900ms in case of `timeout`, * // but here will never be called. * ); * ``` * * @param {number|Date} due Number specifying period within which Observable must emit values * or Date specifying before when Observable should complete * @param {Observable<T>} withObservable Observable which will be subscribed if source fails timeout check. * @param {SchedulerLike} [scheduler] Scheduler controlling when timeout checks occur. * @return {Observable<T>} Observable that mirrors behaviour of source or, when timeout check fails, of an Observable * passed as a second parameter. * @method timeoutWith * @owner Observable */ export function timeoutWith<T, R>(due: number | Date, withObservable: ObservableInput<R>, scheduler: SchedulerLike = async): OperatorFunction<T, T | R> { return (source: Observable<T>) => { let absoluteTimeout = isDate(due); let waitFor = absoluteTimeout ? (+due - scheduler.now()) : Math.abs(<number>due); return source.lift(new TimeoutWithOperator(waitFor, absoluteTimeout, withObservable, scheduler)); }; } class TimeoutWithOperator<T> implements Operator<T, T> { constructor(private waitFor: number, private absoluteTimeout: boolean, private withObservable: ObservableInput<any>, private scheduler: SchedulerLike) { } call(subscriber: Subscriber<T>, source: any): TeardownLogic { return source.subscribe(new TimeoutWithSubscriber( subscriber, this.absoluteTimeout, this.waitFor, this.withObservable, this.scheduler )); } } /** * We need this JSDoc comment for affecting ESDoc. * @ignore * @extends {Ignored} */ class TimeoutWithSubscriber<T, R> extends SimpleOuterSubscriber<T, R> { private action?: SchedulerAction<TimeoutWithSubscriber<T, R>>; constructor(destination: Subscriber<T>, private absoluteTimeout: boolean, private waitFor: number, private withObservable: ObservableInput<any>, private scheduler: SchedulerLike) { super(destination); this.scheduleTimeout(); } private static dispatchTimeout<T, R>(subscriber: TimeoutWithSubscriber<T, R>): void { const { withObservable } = subscriber; subscriber._unsubscribeAndRecycle(); subscriber.add(innerSubscribe(withObservable, new SimpleInnerSubscriber(subscriber))); } private scheduleTimeout(): void { const { action } = this; if (action) { // Recycle the action if we've already scheduled one. All the production // Scheduler Actions mutate their state/delay time and return themeselves. // VirtualActions are immutable, so they create and return a clone. In this // case, we need to set the action reference to the most recent VirtualAction, // to ensure that's the one we clone from next time. this.action = (<SchedulerAction<TimeoutWithSubscriber<T, R>>> action.schedule(this, this.waitFor)); } else { this.add(this.action = (<SchedulerAction<TimeoutWithSubscriber<T, R>>> this.scheduler.schedule<TimeoutWithSubscriber<T, R>>( TimeoutWithSubscriber.dispatchTimeout as any, this.waitFor, this ))); } } protected _next(value: T): void { if (!this.absoluteTimeout) { this.scheduleTimeout(); } super._next(value); } /** @deprecated This is an internal implementation detail, do not use. */ _unsubscribe() { this.action = undefined; this.scheduler = null!; this.withObservable = null!; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
audit.ts | File | 4.14 KB | 0644 |
|
auditTime.ts | File | 2.38 KB | 0644 |
|
buffer.ts | File | 2.54 KB | 0644 |
|
bufferCount.ts | File | 4.46 KB | 0644 |
|
bufferTime.ts | File | 8.51 KB | 0644 |
|
bufferToggle.ts | File | 5.6 KB | 0644 |
|
bufferWhen.ts | File | 3.89 KB | 0644 |
|
catchError.ts | File | 4.72 KB | 0644 |
|
combineAll.ts | File | 2.44 KB | 0644 |
|
combineLatest.ts | File | 4.32 KB | 0644 |
|
concat.ts | File | 2.18 KB | 0644 |
|
concatAll.ts | File | 2.26 KB | 0644 |
|
concatMap.ts | File | 3.4 KB | 0644 |
|
concatMapTo.ts | File | 3.05 KB | 0644 |
|
count.ts | File | 3.78 KB | 0644 |
|
debounce.ts | File | 4.88 KB | 0644 |
|
debounceTime.ts | File | 4.54 KB | 0644 |
|
defaultIfEmpty.ts | File | 2.69 KB | 0644 |
|
delay.ts | File | 5.09 KB | 0644 |
|
delayWhen.ts | File | 7.7 KB | 0644 |
|
dematerialize.ts | File | 2.58 KB | 0644 |
|
distinct.ts | File | 4.22 KB | 0644 |
|
distinctUntilChanged.ts | File | 3.76 KB | 0644 |
|
distinctUntilKeyChanged.ts | File | 2.79 KB | 0644 |
|
elementAt.ts | File | 2.56 KB | 0644 |
|
endWith.ts | File | 4.06 KB | 0644 |
|
every.ts | File | 2.54 KB | 0644 |
|
exhaust.ts | File | 3.2 KB | 0644 |
|
exhaustMap.ts | File | 5.64 KB | 0644 |
|
expand.ts | File | 6.18 KB | 0644 |
|
filter.ts | File | 3.69 KB | 0644 |
|
finalize.ts | File | 1.3 KB | 0644 |
|
find.ts | File | 3.81 KB | 0644 |
|
findIndex.ts | File | 1.86 KB | 0644 |
|
first.ts | File | 3.36 KB | 0644 |
|
groupBy.ts | File | 9.95 KB | 0644 |
|
ignoreElements.ts | File | 1.49 KB | 0644 |
|
index.ts | File | 4.02 KB | 0644 |
|
isEmpty.ts | File | 2.67 KB | 0644 |
|
last.ts | File | 2.36 KB | 0644 |
|
map.ts | File | 3.04 KB | 0644 |
|
mapTo.ts | File | 1.9 KB | 0644 |
|
materialize.ts | File | 3.25 KB | 0644 |
|
max.ts | File | 1.54 KB | 0644 |
|
merge.ts | File | 3.59 KB | 0644 |
|
mergeAll.ts | File | 2.43 KB | 0644 |
|
mergeMap.ts | File | 6.28 KB | 0644 |
|
mergeMapTo.ts | File | 2.56 KB | 0644 |
|
mergeScan.ts | File | 4.65 KB | 0644 |
|
min.ts | File | 1.54 KB | 0644 |
|
multicast.ts | File | 3.46 KB | 0644 |
|
observeOn.ts | File | 5.17 KB | 0644 |
|
onErrorResumeNext.ts | File | 8.18 KB | 0644 |
|
pairwise.ts | File | 2.43 KB | 0644 |
|
partition.ts | File | 2.68 KB | 0644 |
|
pluck.ts | File | 3.07 KB | 0644 |
|
publish.ts | File | 2.51 KB | 0644 |
|
publishBehavior.ts | File | 589 B | 0644 |
|
publishLast.ts | File | 2.06 KB | 0644 |
|
publishReplay.ts | File | 1.47 KB | 0644 |
|
race.ts | File | 1.85 KB | 0644 |
|
reduce.ts | File | 3.71 KB | 0644 |
|
refCount.ts | File | 5 KB | 0644 |
|
repeat.ts | File | 3.03 KB | 0644 |
|
repeatWhen.ts | File | 4.15 KB | 0644 |
|
retry.ts | File | 2.74 KB | 0644 |
|
retryWhen.ts | File | 3.45 KB | 0644 |
|
sample.ts | File | 2.78 KB | 0644 |
|
sampleTime.ts | File | 3.18 KB | 0644 |
|
scan.ts | File | 4.13 KB | 0644 |
|
sequenceEqual.ts | File | 5.16 KB | 0644 |
|
share.ts | File | 1.02 KB | 0644 |
|
shareReplay.ts | File | 4.19 KB | 0644 |
|
single.ts | File | 3.79 KB | 0644 |
|
skip.ts | File | 1.27 KB | 0644 |
|
skipLast.ts | File | 2.81 KB | 0644 |
|
skipUntil.ts | File | 3.81 KB | 0644 |
|
skipWhile.ts | File | 1.95 KB | 0644 |
|
startWith.ts | File | 4.35 KB | 0644 |
|
subscribeOn.ts | File | 2.56 KB | 0644 |
|
switchAll.ts | File | 1.99 KB | 0644 |
|
switchMap.ts | File | 6.04 KB | 0644 |
|
switchMapTo.ts | File | 2.56 KB | 0644 |
|
take.ts | File | 2.74 KB | 0644 |
|
takeLast.ts | File | 3.44 KB | 0644 |
|
takeUntil.ts | File | 2.79 KB | 0644 |
|
takeWhile.ts | File | 3.87 KB | 0644 |
|
tap.ts | File | 5.33 KB | 0644 |
|
throttle.ts | File | 4.83 KB | 0644 |
|
throttleTime.ts | File | 5.83 KB | 0644 |
|
throwIfEmpty.ts | File | 2.19 KB | 0644 |
|
timeInterval.ts | File | 2.49 KB | 0644 |
|
timeout.ts | File | 4.07 KB | 0644 |
|
timeoutWith.ts | File | 6.13 KB | 0644 |
|
timestamp.ts | File | 1.67 KB | 0644 |
|
toArray.ts | File | 1.12 KB | 0644 |
|
window.ts | File | 3.72 KB | 0644 |
|
windowCount.ts | File | 4.82 KB | 0644 |
|
windowTime.ts | File | 9.9 KB | 0644 |
|
windowToggle.ts | File | 6.2 KB | 0644 |
|
windowWhen.ts | File | 4.57 KB | 0644 |
|
withLatestFrom.ts | File | 7.72 KB | 0644 |
|
zip.ts | File | 3.35 KB | 0644 |
|
zipAll.ts | File | 653 B | 0644 |
|