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 fromPromise documentation #229
Open
niklas-wortmann
wants to merge
7
commits into
ReactiveX:master
Choose a base branch
from
niklas-wortmann:add-docs-for-fromPromise
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e3b24a8
docs(operators): add fromPromise documentation
cda197a
docs(operators): fix typo
89e9c89
docs(operators): add es6 import
34d3e81
docs(operators): change server in example
a31728d
Merge branch 'master' of github.com:ReactiveX/rxjs-docs into add-docs…
3d8adac
Merge branch 'master' into add-docs-for-fromPromise
niklas-wortmann 3266e74
Merge branch 'master' into add-docs-for-fromPromise
sumitarora 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,44 @@ | ||
import { OperatorDoc } from '../operator.model'; | ||
|
||
export const fromPromise: OperatorDoc = { | ||
'name': 'fromPromise', | ||
'operatorType': 'creation' | ||
name: 'fromPromise', | ||
operatorType: 'creation', | ||
signature: | ||
'public static fromPromise(promise: Promise<T>, scheduler: Scheduler): Observable<T>', | ||
parameters: [ | ||
{ | ||
name: 'promise', | ||
type: 'Promise<T>', | ||
attribute: '', | ||
description: 'The promise to be converted.' | ||
}, | ||
{ | ||
name: 'scheduler', | ||
type: 'Scheduler', | ||
attribute: 'optional', | ||
description: | ||
'An optional IScheduler to use for scheduling the delivery of the resolved value (or the rejection).' | ||
} | ||
], | ||
shortDescription: { | ||
description: 'Converts a Promise to an Observable.' | ||
}, | ||
walkthrough: { | ||
description: `Converts an ES2015 Promise or a Promises/A+ spec compliant Promise to an Observable. | ||
If the Promise resolves with a value, the output Observable emits that resolved value as a next, | ||
and then completes. If the Promise is rejected, then the output Observable emits the corresponding Error.` | ||
}, | ||
examples: [ | ||
{ | ||
name: 'Convert the Promise returned by Fetch to an Observable', | ||
code: ` | ||
const result = Rx.Observable.fromPromise(fetch('http://myserver.com/')); | ||
result.subscribe(x => console.log(x), e => console.error(e));`, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add expected output also. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this would be rather confusing in this case. Because the operator is more or less like a cast and doesn't manipulate the output. What do you think? Of course I can add an output, but I think it won't add much value in this case. |
||
externalLink: { | ||
platform: 'JSBin', | ||
url: 'http://jsbin.com/warotosaco/embed?js,console,output' | ||
} | ||
} | ||
], | ||
relatedOperators: ['bindCallback', 'from', 'toPromise'] | ||
}; |
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.
please change these to es6 imports, there is an incoming PR from @btroncone converting the existing examples.