From 5e67b10daaa588a2013e1a41591ae66a8af927ef Mon Sep 17 00:00:00 2001 From: Jan-Niklas Wortmann <6104311+JWO719@users.noreply.github.com> Date: Sat, 23 May 2020 14:46:19 +0200 Subject: [PATCH] docs(deprecations): remove jsdoc style from deprecation message --- .../content/guide/higher-order-observables.md | 28 +++++++++++++++++++ src/internal/observable/combineLatest.ts | 14 +++++----- src/internal/observable/concat.ts | 12 ++++---- src/internal/observable/from.ts | 2 +- src/internal/observable/merge.ts | 24 ++++++++-------- src/internal/observable/of.ts | 20 ++++++------- src/internal/operators/endWith.ts | 14 +++++----- src/internal/operators/startWith.ts | 14 +++++----- 8 files changed, 78 insertions(+), 50 deletions(-) create mode 100644 docs_app/content/guide/higher-order-observables.md diff --git a/docs_app/content/guide/higher-order-observables.md b/docs_app/content/guide/higher-order-observables.md new file mode 100644 index 0000000000..d511ea46bf --- /dev/null +++ b/docs_app/content/guide/higher-order-observables.md @@ -0,0 +1,28 @@ +# Higher-order Observables + +Observables most commonly emit ordinary values like strings and numbers, but surprisingly often, it is necessary to handle Observables *of* Observables, so-called higher-order Observables. For example, imagine you have an Observable emitting strings that are the URLs of files you want to fetch. The code might look like this: + +```ts +const fileObservable = urlObservable.pipe( + map(url => http.get(url)), +); +``` + +`http.get()` returns an Observable for each URL. Now you have an Observable *of* Observables, a higher-order Observable. + +But how do you work with a higher-order Observable? Typically, by _flattening_: by converting a higher-order Obser vable into an ordinary Observable. For example: + +```ts +const fileObservable = urlObservable.pipe( + concatMap(url => http.get(url)), +); +``` + +The Observable returned in the `concatMap` function is usually referred to as a so-called "inner" Observable, while in this context the `urlObservable` is the so-called "outer" Observable. + +The [`concatMap()`](/api/operators/concatMap) operator subscribes to each "inner" Observable, buffers all further emissions of the "outer" Observable, and copies all the emitted values until the inner Observable completes, and continues processing the values of the "outer Observable". All of the values are in that way concatenated. Other useful flattening operators are + +* [`mergeMap()`](/api/operators/mergeMap) — subscribes to each inner Observable as it arrives, then emits each value as it arrives +* [`switchMap()`](/api/operators/switchMap) — subscribes to the first inner Observable when it arrives, and emits each value as it arrives, but when the next inner Observable arrives, unsubscribes to the previous one, and subscribes to the new one. +* [`exhaustMap()`](/api/operators/exhaustMap) — subscribes to the first inner Observable when it arrives, and emits each value as it arrives, discarding all newly arriving inner Observables until that first one completes, then waits for the next inner Observable. + diff --git a/src/internal/observable/combineLatest.ts b/src/internal/observable/combineLatest.ts index 1a2cb0fdd6..ea1c13e34a 100644 --- a/src/internal/observable/combineLatest.ts +++ b/src/internal/observable/combineLatest.ts @@ -177,19 +177,19 @@ export function combineLatest< ): Observable; // With a scheduler (deprecated) -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest>(sources: [O1], scheduler: SchedulerLike): Observable<[ObservedValueOf]>; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest, O2 extends ObservableInput>( sources: [O1, O2], scheduler: SchedulerLike ): Observable<[ObservedValueOf, ObservedValueOf]>; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest, O2 extends ObservableInput, O3 extends ObservableInput>( sources: [O1, O2, O3], scheduler: SchedulerLike ): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf]>; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest< O1 extends ObservableInput, O2 extends ObservableInput, @@ -199,7 +199,7 @@ export function combineLatest< sources: [O1, O2, O3, O4], scheduler: SchedulerLike ): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf]>; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest< O1 extends ObservableInput, O2 extends ObservableInput, @@ -210,7 +210,7 @@ export function combineLatest< sources: [O1, O2, O3, O4, O5], scheduler: SchedulerLike ): Observable<[ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf]>; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest< O1 extends ObservableInput, O2 extends ObservableInput, @@ -224,7 +224,7 @@ export function combineLatest< ): Observable< [ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf, ObservedValueOf] >; -/** @deprecated The scheduler argument is deprecated, use {@link subscribeOn} and/or {@link observeOn}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use subscribeOn and/or observeOn. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function combineLatest>(sources: O[], scheduler: SchedulerLike): Observable[]>; // Best case diff --git a/src/internal/observable/concat.ts b/src/internal/observable/concat.ts index addb22a87d..e15b6c99f4 100644 --- a/src/internal/observable/concat.ts +++ b/src/internal/observable/concat.ts @@ -5,17 +5,17 @@ import { isScheduler } from '../util/isScheduler'; import { fromArray } from './fromArray'; /* tslint:disable:max-line-length */ -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat>(v1: O1, scheduler: SchedulerLike): Observable>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat, O2 extends ObservableInput>(v1: O1, v2: O2, scheduler: SchedulerLike): Observable | ObservedValueOf>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat, O2 extends ObservableInput, O3 extends ObservableInput>(v1: O1, v2: O2, v3: O3, scheduler: SchedulerLike): Observable | ObservedValueOf | ObservedValueOf>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4, scheduler: SchedulerLike): Observable | ObservedValueOf | ObservedValueOf | ObservedValueOf>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, scheduler: SchedulerLike): Observable | ObservedValueOf | ObservedValueOf | ObservedValueOf | ObservedValueOf>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function concat, O2 extends ObservableInput, O3 extends ObservableInput, O4 extends ObservableInput, O5 extends ObservableInput, O6 extends ObservableInput>(v1: O1, v2: O2, v3: O3, v4: O4, v5: O5, v6: O6, scheduler: SchedulerLike): Observable | ObservedValueOf | ObservedValueOf | ObservedValueOf | ObservedValueOf | ObservedValueOf>; export function concat[]>(...observables: A): Observable>; diff --git a/src/internal/observable/from.ts b/src/internal/observable/from.ts index 0014a3c546..9795d438b6 100644 --- a/src/internal/observable/from.ts +++ b/src/internal/observable/from.ts @@ -16,7 +16,7 @@ import { ObservableInput, SchedulerLike, ObservedValueOf } from '../types'; import { scheduled } from '../scheduled/scheduled'; export function from>(input: O): Observable>; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function from>(input: O, scheduler: SchedulerLike): Observable>; /** diff --git a/src/internal/observable/merge.ts b/src/internal/observable/merge.ts index 2648bff3d9..5b6be7484c 100644 --- a/src/internal/observable/merge.ts +++ b/src/internal/observable/merge.ts @@ -9,27 +9,27 @@ import { from } from './from'; import { EMPTY } from './empty'; /* tslint:disable:max-line-length */ -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge(v1: ObservableInput, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge(v1: ObservableInput, concurrent: number, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge(v1: ObservableInput, v2: ObservableInput, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, concurrent: number, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -37,7 +37,7 @@ export function merge( concurrent: number, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -45,7 +45,7 @@ export function merge( v4: ObservableInput, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -54,7 +54,7 @@ export function merge( concurrent: number, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -63,7 +63,7 @@ export function merge( v5: ObservableInput, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -73,7 +73,7 @@ export function merge( concurrent: number, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, @@ -83,7 +83,7 @@ export function merge( v6: ObservableInput, scheduler: SchedulerLike ): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link mergeAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and mergeAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function merge( v1: ObservableInput, v2: ObservableInput, diff --git a/src/internal/observable/of.ts b/src/internal/observable/of.ts index 4e2d7d905f..115b3cb085 100644 --- a/src/internal/observable/of.ts +++ b/src/internal/observable/of.ts @@ -5,27 +5,27 @@ import { Observable } from '../Observable'; import { scheduleArray } from '../scheduled/scheduleArray'; /* tslint:disable:max-line-length */ -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, e: T5, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, e: T5, f: T6, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7, h: T8, scheduler: SchedulerLike): Observable; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function of(a: T, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7, h: T8, i: T9, scheduler: SchedulerLike): Observable; diff --git a/src/internal/operators/endWith.ts b/src/internal/operators/endWith.ts index ceb650bd7b..974fff5144 100644 --- a/src/internal/operators/endWith.ts +++ b/src/internal/operators/endWith.ts @@ -4,19 +4,19 @@ import { of } from '../observable/of'; import { MonoTypeOperatorFunction, SchedulerLike, OperatorFunction, ValueFromArray } from '../types'; /* tslint:disable:max-line-length */ -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(scheduler: SchedulerLike): MonoTypeOperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, v2: B, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, v2: B, v3: C, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, v2: B, v3: C, v4: D, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, v2: B, v3: C, v4: D, v5: E, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function endWith(v1: A, v2: B, v3: C, v4: D, v5: E, v6: F, scheduler: SchedulerLike): OperatorFunction; export function endWith(...args: A): OperatorFunction>; diff --git a/src/internal/operators/startWith.ts b/src/internal/operators/startWith.ts index 51fa5eeb06..24b448e4ff 100644 --- a/src/internal/operators/startWith.ts +++ b/src/internal/operators/startWith.ts @@ -4,19 +4,19 @@ import { isScheduler } from '../util/isScheduler'; import { MonoTypeOperatorFunction, OperatorFunction, SchedulerLike, ValueFromArray } from '../types'; /* tslint:disable:max-line-length */ -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(scheduler: SchedulerLike): MonoTypeOperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, v2: E, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, v2: E, v3: F, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, v2: E, v3: F, v4: G, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, v2: E, v3: F, v4: G, v5: H, scheduler: SchedulerLike): OperatorFunction; -/** @deprecated The scheduler argument is deprecated, use {@link scheduled} and {@link concatAll}. Details: {@link https://rxjs.dev/deprecations/scheduler-argument} */ +/** @deprecated The scheduler argument is deprecated, use scheduled and concatAll. Details: https://rxjs.dev/deprecations/scheduler-argument */ export function startWith(v1: D, v2: E, v3: F, v4: G, v5: H, v6: I, scheduler: SchedulerLike): OperatorFunction; export function startWith(...values: A): OperatorFunction>;