Merge pull request #153 from natmegs/doc-creation-map

docs(operators): add documentation for operator map

Author: ashwin-sureshkumar

src/operator-docs/transformation/map.ts

@@ -1,6 +1,56 @@
 import { OperatorDoc } from '../operator.model';
 
 export const map: OperatorDoc = {
-  'name': 'map',
-  'operatorType': 'transformation'
+  name: 'map',
+  operatorType: 'transformation',
+  signature: 'public map(project: Function, thisArg: any): Observable',
+  parameters: [
+    {
+      name: 'project',
+      type: '(value: T, index: number) => R',
+      attribute: '',
+      description: `The function to apply to each 'value' emitted by the source Observable. The 'index' parameter is the number 'i'
+        for the i-th emission that has happened since the subscription, starting from the number '0'.`
+    },
+    {
+      name: 'thisArg',
+      type: 'any',
+      attribute: 'optional',
+      description:
+        "An optional argument to define what this is in the 'project' function."
+    }
+  ],
+  marbleUrl: 'http://reactivex.io/rxjs/img/map.png',
+  shortDescription: {
+    description: `
+      Applies a given <span class="markdown-code">project</span> function to each value emitted by the source
+      Observable, and emits the resulting values as an Observable.
+    `,
+    extras: []
+  },
+  walkthrough: {
+    description: `
+      <p>
+        Similar to the well known <span class="markdown-code">Array.prototype.map</span> function,
+        this operator applies a projection to each value and emits that projection in the output
+        Observable.
+      </p>
+    `
+  },
+  examples: [
+    {
+      name: 'Map every click to the clientX position of that click',
+      code: `
+        let clicks = Rx.Observable.fromEvent(document, 'click');
+        let positions = clicks.map(ev => ev.clientX);
+        positions.subscribe(x => console.log(x));
+      `,
+      externalLink: {
+        platform: 'JSBin',
+        url: 'http://jsbin.com/dutered/embed?js,console,output'
+      }
+    }
+  ],
+  relatedOperators: ['mapTo', 'pluck'],
+  additionalResources: []
 };