import { async } from '../scheduler/async';
import { isValidDate } from '../util/isDate';
import { ObservableInput, OperatorFunction, SchedulerLike } from '../types';
import { timeout } from './timeout';
/**
* If the time of the Date object passed arrives before the first value arrives from the source, it will unsubscribe
* from the source and switch the subscription to another observable.
*
* Use to switch to a different observable if the first value doesn't arrive by a specific time
*
* Can be used to set a timeout only for the first value, however it's recommended to use the {@link timeout} operator with
* the `first` configuration to get that effect.
*
* @param dueBy The exact time, as a `Date`, at which the timeout will be triggered if the first value does not arrive.
* @param switchTo The observable to switch to when timeout occurs.
* @param scheduler The scheduler to use with time-related operations within this operator. Defaults to {@link asyncScheduler}
* @deprecated Replaced with {@link timeout}. Instead of `timeoutWith(someDate, a$, scheduler)`, use the configuration object `timeout({ first: someDate, with: () => a$, scheduler })`. Will be removed in v8.
*/
export function timeoutWith(dueBy: Date, switchTo: ObservableInput, scheduler?: SchedulerLike): OperatorFunction;
/**
* When the passed timespan ellapses before the source emits any given value, it will unsubscribe from the source,
* and switch the subscription to another observable.
*
* Used to switch to a different observable if your source is being slow
*
* Useful in cases where:
*
* - You want to switch to a different source that may be faster
* - You want to notify a user that the data stream is slow
* - You want to emit a custom error rather than the {@link TimeoutError} emitted
* by the default usage of {@link timeout}.
*
* ## Example
*
* Fallback to a faster observable
*
* ```ts
* import { interval } from 'rxjs';
* import { timeoutWith } from 'rxjs/operators';
*
* const slow$ = interval(1000);
* const faster$ = interval(500);
*
* slow$.pipe(
* timeoutWith(900, faster$)
* )
* .subscribe(console.log)
* ```
*
* ### Example
*
* Emit your own custom timeout error
*
* ```ts
* import { interval, throwError } from 'rxjs';
* import { timeoutWith } from 'rxjs/operators';
*
* class CustomTimeoutError extends Error {
* constructor() {
* super('It was too slow');
* this.name = 'CustomTimeoutError';
* }
* }
*
* const slow = interval(1000);
*
* slow$.pipe(
* timeoutWith(900, throwError(new CustomTimeoutError()))
* )
* .subscribe({
* error: console.error
* })
* ```
* @param waitFor The time allowed between values from the source before timeout is triggered.
* @param switchTo The observable to switch to when timeout occurs.
* @param scheduler The scheduler to use with time-related operations within this operator. Defaults to {@link asyncScheduler}
* @return A function that returns an Observable that mirrors behaviour of the
* source Observable, unless timeout happens when it starts emitting values
* from the Observable passed as a second parameter.
* @deprecated Replaced with {@link timeout}. Instead of `timeoutWith(100, a$, scheduler)`, use the configuration object `timeout({ each: 100, with: () => a$, scheduler })`. Will be removed in v8.
*/
export function timeoutWith(waitFor: number, switchTo: ObservableInput, scheduler?: SchedulerLike): OperatorFunction;
export function timeoutWith(
due: number | Date,
withObservable: ObservableInput,
scheduler?: SchedulerLike
): OperatorFunction {
let first: number | Date | undefined;
let each: number | undefined;
let _with: () => ObservableInput;
scheduler = scheduler ?? async;
if (isValidDate(due)) {
first = due;
} else if (typeof due === 'number') {
each = due;
}
if (withObservable) {
_with = () => withObservable;
} else {
throw new TypeError('No observable provided to switch to');
}
if (first == null && each == null) {
// Ensure timeout was provided at runtime.
throw new TypeError('No timeout provided.');
}
return timeout>({
first,
each,
scheduler,
with: _with,
});
}