Merge remote-tracking branch 'upstream/master' into multipages

Author: feloy

.gitignore

@@ -10,6 +10,7 @@
 
 # IDEs and editors
 /.idea
+*.iml
 .project
 .classpath
 .c9/

src/operator-docs/combination/combineLatest.ts

@@ -1,34 +1,42 @@
-import { OperatorDoc } from "../operator.model";
+import { OperatorDoc } from '../operator.model';
 
 export const combineLatest: OperatorDoc = {
-  name: "combineLatest",
-  operatorType: "combination",
+  name: 'combineLatest',
+  operatorType: 'combination',
   signature:
-    "public combineLatest(observables: ...Observable, project: function): Observable",
+    'public combineLatest(observables: ...Observable, project: function): Observable',
   useInteractiveMarbles: true,
   parameters: [
     {
-      name: "other",
-      type: "Observable",
-      attribute: "",
+      name: 'other',
+      type: 'Observable',
+      attribute: '',
       description:
-        "An input Observable to combine with the source Observable. More than one input Observables may be given as argument."
+        'An input Observable to combine with the source Observable. More than one input Observables may be given as argument.'
     },
     {
-      name: "other",
-      type: "function",
-      attribute: "optional",
+      name: 'other',
+      type: 'function',
+      attribute: 'optional',
       description:
-        "An optional function to project the values from the combined latest values into a new value on the output Observable."
+        'An optional function to project the values from the combined latest values into a new value on the output Observable.'
     }
   ],
-  marbleUrl: "http://reactivex.io/rxjs/img/combineLatest.png",
+  marbleUrl: 'http://reactivex.io/rxjs/img/combineLatest.png',
   shortDescription: {
     description: `
       Combines multiple Observables to create an Observable whose values
       are calculated from the latest values of each of its input Observables.
     `,
-    extras: []
+    extras: [
+      {
+        type: 'Tip',
+        text: `
+          Note: combineLatest will only start to emit when all sources have emitted at least once. By adding a default
+           start value to the sources with <a href="/operators#startWith">.startWith</a>, it will activate right away.
+         `
+      }
+    ]
   },
   walkthrough: {
     description: `
@@ -46,7 +54,7 @@ export const combineLatest: OperatorDoc = {
   examples: [
     {
       name:
-        "Dynamically calculate the Body-Mass Index from an Observable of weight and one for height",
+        'Dynamically calculate the Body-Mass Index from an Observable of weight and one for height',
       code: `
         const weight = Rx.Observable.of(70, 72, 76, 79, 75);
         const height = Rx.Observable.of(1.76, 1.77, 1.78);
@@ -60,11 +68,11 @@ export const combineLatest: OperatorDoc = {
         bmi.subscribe(x => console.log('BMI is ' + x));
       `,
       externalLink: {
-        platform: "JSBin",
-        url: "http://jsbin.com/pivowunedu/1/embed?js,console"
+        platform: 'JSBin',
+        url: 'http://jsbin.com/pivowunedu/1/embed?js,console'
       }
     }
   ],
-  relatedOperators: ["combineAll", "merge", "withLatestFrom"],
+  relatedOperators: ['combineAll', 'merge', 'withLatestFrom'],
   additionalResources: []
 };

src/operator-docs/creation/empty.ts

@@ -1,6 +1,70 @@
 import { OperatorDoc } from '../operator.model';
 
 export const empty: OperatorDoc = {
-  'name': 'empty',
-  'operatorType': 'creation'
+  name: 'empty',
+  operatorType: 'creation',
+  signature: 'public empty<T>(scheduler?: IScheduler): Observable<T>',
+  parameters: [
+    {
+      name: 'scheduler',
+      type: 'IScheduler',
+      attribute: 'optional',
+      description:
+        'Allows scheduling the emission of the complete notification.'
+    }
+  ],
+  marbleUrl: 'http://reactivex.io/rxjs/img/empty.png',
+  shortDescription: {
+    description:
+      'Creates an Observable that emits no items to the Observer' +
+      ' and immediately emits a complete notification.'
+  },
+  walkthrough: {
+    description: `This static operator is useful for creating a simple
+       Observable that only emits the complete notification. It can be used for
+       composing with other Observables`
+  },
+  examples: [
+    {
+      name: 'Observable completes immediately',
+      code: `const observable = Rx.Observable.empty();
+             const subscription = observable.subscribe({
+               next: () => console.log('next'), // does not log anything
+               complete: () => console.log('complete'), // logs 'complete'
+             });`,
+      externalLink: {
+        platform: 'JSBin',
+        url: 'http://jsbin.com/hojacunecu/1/edit?js,console,output'
+      }
+    },
+    {
+      name: 'Observable emits initial value then completes',
+      code: `const observable = Rx.Observable.empty().startWith('initial value');
+             const subscription = observable.subscribe({
+               next: (val) => console.log(\`next: \${val}\`), // logs 'next: initial value'
+               complete: () => console.log('complete'), // logs 'complete'
+             });`,
+      externalLink: {
+        platform: 'JSBin',
+        url: 'http://jsbin.com/tubonoradi/1/edit?js,console,output'
+      }
+    },
+    {
+      name: `Map and flatten only odd numbers to the sequence 'ax', 'bx', 'cx'`,
+      code: `const source = Rx.Observable.of(1, 2, 3, 4, 5, 6, 7, 8, 9);
+             const result = source.mergeMap(
+               x => x % 2 === 1 ? Rx.Observable.of(\`a\${x}\`, \`b\${x}\`, \`c\${x}\`) :
+                                  Rx.Observable.empty()
+             );
+             const subscription = result.subscribe({
+               next: (x) => console.log(x), // logs result values
+               complete: () => console.log('complete'), // logs 'complete'
+             });`,
+      externalLink: {
+        platform: 'JSBin',
+        url: 'http://jsbin.com/qazabojiri/edit?js,console,output'
+      }
+    }
+  ],
+  relatedOperators: ['create', 'of', 'throw']
 };