This repository has been archived by the owner on Oct 1, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 62
docs(operators): add documentation for operator map #153
Merged
ashwin-sureshkumar
merged 4 commits into
ReactiveX:master
from
natmegs:doc-creation-map
Nov 27, 2017
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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', | ||
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: [] | ||
}; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.