Skip to content

Commit

Permalink
docs(toArray): added description and example for toArray (#4775)
Browse files Browse the repository at this point in the history
  • Loading branch information
waseemahmad31 authored and benlesh committed Jun 5, 2019
1 parent 81f913f commit 68d5128
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions src/internal/operators/toArray.ts
Expand Up @@ -9,6 +9,37 @@ function toArrayReducer<T>(arr: T[], item: T, index: number) {
return arr;
}

/**
* Collects all source emissions and emits them as an array when the source completes.
*
* <span class="informal">Get all values inside an array when the source completes</span>
*
* ![](toArray.png)
*
* `toArray` will wait until the source Observable completes before emitting
* the array containing all emissions. When the source Observable errors no
* array will be emitted.
*
* ## Example
* ```ts
* import { interval } from 'rxjs';
* import { toArray, take } from 'rxjs/operators';
*
* const source = interval(1000);
* const example = source.pipe(
* take(10),
* toArray()
* );
*
* const subscribe = example.subscribe(val => console.log(val));
*
* // output: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
*
* ```
* @return An array from an observable sequence.
* @method toArray
* @owner Observable
*/
export function toArray<T>(): OperatorFunction<T, T[]> {
return reduce(toArrayReducer, [] as T[]);
}

0 comments on commit 68d5128

Please sign in to comment.