26 lines
860 B
TypeScript
26 lines
860 B
TypeScript
|
import { Observable } from '../Observable';
|
||
|
|
/**
|
||
|
|
* 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>
|
||
|
|
*
|
||
|
|
* <img src="./img/toArray.png" width="100%">
|
||
|
|
*
|
||
|
|
* `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 <caption>Create array from input</caption>
|
||
|
|
* const input = Rx.Observable.interval(100).take(4);
|
||
|
|
*
|
||
|
|
* input.toArray()
|
||
|
|
* .subscribe(arr => console.log(arr)); // [0,1,2,3]
|
||
|
|
*
|
||
|
|
* @see {@link buffer}
|
||
|
|
*
|
||
|
|
* @return {Observable<any[]>|WebSocketSubject<T>|Observable<T>}
|
||
|
|
* @method toArray
|
||
|
|
* @owner Observable
|
||
|
|
*/
|
||
|
|
export declare function toArray<T>(this: Observable<T>): Observable<T[]>;
|