docs(ObservableInput): add ObservableInput and SubscribableOrPromise descriptions #2373
Conversation
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
jayphelps
suggested changes
Feb 14, 2017
src/MiscJSDoc.ts
Outdated
| * `ObservableInput` interface describes all values that are observables, | ||
| * or can be treated as such. Every operator that accepts arguments annotated | ||
| * with this interface, can be also used with parameters that are not necessarily | ||
| * RxJS Observables. |
There was a problem hiding this comment.
The two descriptions for SubscribableOrPromise and ObservableInput seem to start with the same statement but not entirely accurate.
X interface describes all values that are observables, or can be treated as such.
| * Operators will accept both built-in and custom ES6 Iterables, by treating them as | ||
| * observables that emit all its values in order of iteration and then complete | ||
| * when iteration ends. Note that contrary to arrays, Iterables do not have to | ||
| * necessarily be finite, so creating Observables that never complete is possible as well. |
There was a problem hiding this comment.
The infinite iterator use case is not well known but very powerful and easy with generators. I think an example that uses generators would be very very useful.
// infinite stream of incrementing numbers
const infinite = function* () {
let i = 0;
while (true) {
yield i++;
}
};
Rx.Observable.from(infinite())
.take(3) // only take 3, cause this is infinite
.subscribe(
value => console.log(value),
err => {},
() => console.log('ta dam!')
);
// 0
// 1
// 2
…descriptions Add ObservableInput and SubscribableOrPromise interface descriptions, as well as link these interfaces in type descriptions of operators, so that users always know what kind of parameters they can pass to used methods.
|
@jayphelps I made the changes you requested. |
jayphelps
approved these changes
Feb 15, 2017
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description:
Add
ObservableInputandSubscribableOrPromiseinterface descriptions, as well as link these interfaces in type descriptions of operators, so that users always know what kind of parameters they can pass to used methods.Related issues:
#2326
#2344
#2351