diff --git a/src/operator-docs/combination/mergeAll.ts b/src/operator-docs/combination/mergeAll.ts index d0be8ca6..ea96d3fc 100644 --- a/src/operator-docs/combination/mergeAll.ts +++ b/src/operator-docs/combination/mergeAll.ts @@ -1,6 +1,77 @@ -import { OperatorDoc } from '../operator.model'; +import { OperatorDoc } from "../operator.model"; export const mergeAll: OperatorDoc = { - 'name': 'mergeAll', - 'operatorType': 'combination' + name: "mergeAll", + operatorType: "combination", + signature: "public mergeAll(concurrent: number): Observable", + parameters: [ + { + name: "concurrent", + type: "number", + attribute: "optional, default: Number.POSITIVE_INFINITY", + description: `Maximum number of input Observables being subscribed to concurrently.` + } + ], + marbleUrl: "http://reactivex.io/rxjs/img/mergeAll.png", + shortDescription: { + description: `Converts a higher-order Observable into a first-order Observable which concurrently + delivers all values that are emitted on the inner Observables`, + extras: [ + { + type: "Tip", + text: "Flattens an Observable-of-Observables." + } + ] + }, + walkthrough: { + description: ` +
MergeAll subscribes to an Observable that emits Observables,
+ also known as a higher-order Observable. Each time it observes one of these emitted
+ inner Observables, it subscribes to that and delivers all the values from the inner
+ Observable on the output Observable. The output Observable only completes once all inner
+ Observables have completed. Any error delivered by a inner Observable will be immediately
+ emitted on the output Observable.