1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
import { OperatorFunction } from '../types';
/**
* Groups pairs of consecutive emissions together and emits them as an array of
* two values.
*
* <span class="informal">Puts the current value and previous value together as
* an array, and emits that.</span>
*
* 
*
* The Nth emission from the source Observable will cause the output Observable
* to emit an array [(N-1)th, Nth] of the previous and the current value, as a
* pair. For this reason, `pairwise` emits on the second and subsequent
* emissions from the source Observable, but not on the first emission, because
* there is no previous value in that case.
*
* ## Example
* On every click (starting from the second), emit the relative distance to the previous click
* ```javascript
* import { fromEvent } from 'rxjs';
* import { pairwise, map } from 'rxjs/operators';
*
* const clicks = fromEvent(document, 'click');
* const pairs = clicks.pipe(pairwise());
* const distance = pairs.pipe(
* map(pair => {
* const x0 = pair[0].clientX;
* const y0 = pair[0].clientY;
* const x1 = pair[1].clientX;
* const y1 = pair[1].clientY;
* return Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2));
* }),
* );
* distance.subscribe(x => console.log(x));
* ```
*
* @see {@link buffer}
* @see {@link bufferCount}
*
* @return {Observable<Array<T>>} An Observable of pairs (as arrays) of
* consecutive values from the source Observable.
* @method pairwise
* @owner Observable
*/
export declare function pairwise<T>(): OperatorFunction<T, [T, T]>;
|
