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

docs(operators): add documentation for operator map #153

Merged
merged 4 commits into from
Nov 27, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 52 additions & 2 deletions src/operator-docs/transformation/map.ts
Original file line number Diff line number Diff line change
@@ -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',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could mark optional parameters with question mark:

public map(project: Function, thisArg?: any)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an issue to discuss this #168 so this PR should be good to go.

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: []
};