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

Commit 5eb3cab

Browse files
authored
Merge branch 'master' into doc-do-branch
2 parents f29f509 + 8e84e13 commit 5eb3cab

File tree

2 files changed

+298
-43
lines changed

2 files changed

+298
-43
lines changed
Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
1-
import { OperatorDoc } from "../operator.model";
1+
import { OperatorDoc } from '../operator.model';
22

33
export const combineLatest: OperatorDoc = {
4-
name: "combineLatest",
5-
operatorType: "combination",
4+
name: 'combineLatest',
5+
operatorType: 'combination',
66
signature:
7-
"public combineLatest(observables: ...Observable, project: function): Observable",
7+
'public combineLatest(observables: ...Observable, project: function): Observable',
88
useInteractiveMarbles: true,
99
parameters: [
1010
{
11-
name: "other",
12-
type: "Observable",
13-
attribute: "",
11+
name: 'other',
12+
type: 'Observable',
13+
attribute: '',
1414
description:
15-
"An input Observable to combine with the source Observable. More than one input Observables may be given as argument."
15+
'An input Observable to combine with the source Observable. More than one input Observables may be given as argument.'
1616
},
1717
{
18-
name: "other",
19-
type: "function",
20-
attribute: "optional",
18+
name: 'other',
19+
type: 'function',
20+
attribute: 'optional',
2121
description:
22-
"An optional function to project the values from the combined latest values into a new value on the output Observable."
22+
'An optional function to project the values from the combined latest values into a new value on the output Observable.'
2323
}
2424
],
25-
marbleUrl: "http://reactivex.io/rxjs/img/combineLatest.png",
25+
marbleUrl: 'http://reactivex.io/rxjs/img/combineLatest.png',
2626
shortDescription: {
2727
description: `
2828
Combines multiple Observables to create an Observable whose values
2929
are calculated from the latest values of each of its input Observables.
3030
`,
31-
extras: []
31+
extras: [
32+
{
33+
type: 'Tip',
34+
text: `
35+
Note: combineLatest will only start to emit when all sources have emitted at least once. By adding a default
36+
start value to the sources with <a href="/operators#startWith">.startWith</a>, it will activate right away.
37+
`
38+
}
39+
]
3240
},
3341
walkthrough: {
3442
description: `
@@ -46,7 +54,7 @@ export const combineLatest: OperatorDoc = {
4654
examples: [
4755
{
4856
name:
49-
"Dynamically calculate the Body-Mass Index from an Observable of weight and one for height",
57+
'Dynamically calculate the Body-Mass Index from an Observable of weight and one for height',
5058
code: `
5159
const weight = Rx.Observable.of(70, 72, 76, 79, 75);
5260
const height = Rx.Observable.of(1.76, 1.77, 1.78);
@@ -60,11 +68,11 @@ export const combineLatest: OperatorDoc = {
6068
bmi.subscribe(x => console.log('BMI is ' + x));
6169
`,
6270
externalLink: {
63-
platform: "JSBin",
64-
url: "http://jsbin.com/pivowunedu/1/embed?js,console"
71+
platform: 'JSBin',
72+
url: 'http://jsbin.com/pivowunedu/1/embed?js,console'
6573
}
6674
}
6775
],
68-
relatedOperators: ["combineAll", "merge", "withLatestFrom"],
76+
relatedOperators: ['combineAll', 'merge', 'withLatestFrom'],
6977
additionalResources: []
7078
};

0 commit comments

Comments
 (0)