Skip to content
This repository was archived by the owner on Apr 20, 2018. It is now read-only.

Commit 4898a04

Browse files
Updating docs for zip/combineLatest
1 parent b806fa8 commit 4898a04

4 files changed

Lines changed: 139 additions & 31 deletions

File tree

doc/api/core/operators/combinelatest.md

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,36 @@ Merges the specified observable sequences into one observable sequence by using
1212

1313
#### Example
1414
```js
15+
/* Have staggering intervals */
16+
var source1 = Rx.Observable.interval(100)
17+
.map(function (i) { return 'First: ' + i; });
18+
19+
var source2 = Rx.Observable.interval(150)
20+
.map(function (i) { return 'Second: ' + i; });
21+
22+
// Combine latest of source1 and source2 whenever either gives a value with a selector
23+
var source = Rx.Observable.combineLatest(
24+
source1,
25+
source2
26+
).take(4);
27+
28+
var subscription = source.subscribe(
29+
function (x) {
30+
console.log('Next: %s', x);
31+
},
32+
function (err) {
33+
console.log('Error: %s', err);
34+
},
35+
function () {
36+
console.log('Completed');
37+
});
38+
39+
// => Next: First: 0,Second: 0
40+
// => Next: First: 1,Second: 0
41+
// => Next: First: 1,Second: 1
42+
// => Next: First: 2,Second: 1
43+
// => Completed
44+
1545
/* Have staggering intervals */
1646
var source1 = Rx.Observable.interval(100)
1747
.map(function (i) { return 'First: ' + i; });
@@ -27,15 +57,15 @@ var source = Rx.Observable.combineLatest(
2757
).take(4);
2858

2959
var subscription = source.subscribe(
30-
function (x) {
31-
console.log('Next: %s', x);
32-
},
33-
function (err) {
34-
console.log('Error: %s', err);
35-
},
36-
function () {
37-
console.log('Completed');
38-
});
60+
function (x) {
61+
console.log('Next: %s', x);
62+
},
63+
function (err) {
64+
console.log('Error: %s', err);
65+
},
66+
function () {
67+
console.log('Completed');
68+
});
3969

4070
// => Next: First: 0, Second: 0
4171
// => Next: First: 1, Second: 0

doc/api/core/operators/combinelatestproto.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,35 @@ Merges the specified observable sequences into one observable sequence by using
1212

1313
#### Example
1414
```js
15+
/* Have staggering intervals */
16+
var source1 = Rx.Observable.interval(100)
17+
.map(function (i) { return 'First: ' + i; });
18+
19+
var source2 = Rx.Observable.interval(150)
20+
.map(function (i) { return 'Second: ' + i; });
21+
22+
// Combine latest of source1 and source2 whenever either gives a value with selector
23+
var source = source1.combineLatest(
24+
source2
25+
).take(4);
26+
27+
var subscription = source.subscribe(
28+
function (x) {
29+
console.log('Next: %s', x);
30+
},
31+
function (err) {
32+
console.log('Error: %s', err);
33+
},
34+
function () {
35+
console.log('Completed');
36+
});
37+
38+
// => Next: First: 0,Second: 0
39+
// => Next: First: 1,Second: 0
40+
// => Next: First: 1,Second: 1
41+
// => Next: First: 2,Second: 1
42+
// => Completed
43+
1544
/* Have staggering intervals */
1645
var source1 = Rx.Observable.interval(100)
1746
.map(function (i) { return 'First: ' + i; });

doc/api/core/operators/zip.md

Lines changed: 47 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,41 @@ Merges the specified observable sequences or Promises into one observable sequen
1212

1313
#### Example
1414
```js
15-
/* Using arguments */
15+
/* Without a result selector */
1616
var range = Rx.Observable.range(0, 5);
1717

1818
var source = Observable.zip(
19-
range,
20-
range.skip(1),
21-
range.skip(2),
22-
function (s1, s2, s3) {
23-
return s1 + ':' + s2 + ':' + s3;
24-
}
19+
range,
20+
range.skip(1),
21+
range.skip(2)
22+
);
23+
24+
var subscription = source.subscribe(
25+
function (x) {
26+
console.log('Next: %s', x);
27+
},
28+
function (err) {
29+
console.log('Error: %s', err);
30+
},
31+
function () {
32+
console.log('Completed');
33+
});
34+
35+
// => Next: 0,1,2
36+
// => Next: 1,2,3
37+
// => Next: 2,3,4
38+
// => Completed
39+
40+
/* With a result selector */
41+
var range = Rx.Observable.range(0, 5);
42+
43+
var source = Observable.zip(
44+
range,
45+
range.skip(1),
46+
range.skip(2),
47+
function (s1, s2, s3) {
48+
return s1 + ':' + s2 + ':' + s3;
49+
}
2550
);
2651

2752
var subscription = source.subscribe(
@@ -44,24 +69,24 @@ var subscription = source.subscribe(
4469
var range = Rx.Observable.range(0, 5);
4570

4671
var source = Observable.zip(
47-
RSVP.Promise.resolve(0),
48-
RSVP.Promise.resolve(1),
49-
Rx.Observable.return(2)
50-
function (s1, s2, s3) {
51-
return s1 + ':' + s2 + ':' + s3;
52-
}
72+
Promise.resolve(0),
73+
Promise.resolve(1),
74+
Rx.Observable.return(2)
75+
function (s1, s2, s3) {
76+
return s1 + ':' + s2 + ':' + s3;
77+
}
5378
);
5479

5580
var subscription = source.subscribe(
56-
function (x) {
57-
console.log('Next: ' + x);
58-
},
59-
function (err) {
60-
console.log('Error: ' + err);
61-
},
62-
function () {
63-
console.log('Completed');
64-
});
81+
function (x) {
82+
console.log('Next: %s', x);
83+
},
84+
function (err) {
85+
console.log('Error: %s', err);
86+
},
87+
function () {
88+
console.log('Completed');
89+
});
6590

6691
// => Next: 0:1:2
6792
// => Completed

doc/api/core/operators/zipproto.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,30 @@ Merges the specified observable sequences or Promises into one observable sequen
1212

1313
#### Example
1414
```js
15+
/* Without a result selector */
16+
var range = Rx.Observable.range(0, 5);
17+
18+
var source = range.zip(
19+
range.skip(1),
20+
range.skip(2)
21+
);
22+
23+
var subscription = source.subscribe(
24+
function (x) {
25+
console.log('Next: %s', x);
26+
},
27+
function (err) {
28+
console.log('Error: %s', err);
29+
},
30+
function () {
31+
console.log('Completed');
32+
});
33+
34+
// => Next: 0,1,2
35+
// => Next: 1,2,3
36+
// => Next: 2,3,4
37+
// => Completed
38+
1539
/* Using arguments */
1640
var range = Rx.Observable.range(0, 5);
1741

0 commit comments

Comments
 (0)