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 of #265
Open
niklas-wortmann
wants to merge
5
commits into
ReactiveX:master
Choose a base branch
from
niklas-wortmann:add-docs-for-of
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.
+64
−2
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f6508d7
docs(operators): add documentation for of
733e57e
docs(operators): fix naming conflict and combine concats
256b3ce
Merge branch 'master' of github.com:ReactiveX/rxjs-docs into add-docs…
92bf508
Merge branch 'master' into add-docs-for-of
sumitarora 09e67c4
Merge branch 'master' into add-docs-for-of
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,69 @@ | ||
import { OperatorDoc } from '../operator.model'; | ||
|
||
export const ofOperator: OperatorDoc = { | ||
'name': 'of', | ||
'operatorType': 'creation' | ||
name: 'of', | ||
operatorType: 'creation', | ||
signature: 'public of(values: ...T, scheduler: IScheduler ): Observable', | ||
parameters: [ | ||
{ | ||
name: 'args', | ||
type: 'T', | ||
description: 'Arguments that represent next values to be emitted.', | ||
attribute: '' | ||
}, | ||
{ | ||
name: 'scheduler', | ||
type: 'IScheduler', | ||
description: | ||
'A IScheduler to use for scheduling the emissions of the next notifications.', | ||
attribute: 'optional' | ||
} | ||
], | ||
relatedOperators: ['create', 'empty', 'never', 'throw'], | ||
marbleUrl: 'http://reactivex.io/rxjs/img/of.png', | ||
shortDescription: { | ||
description: `Creates an Observable that emits some values you specify as arguments, | ||
immediately one after the other, and then emits a complete notification.` | ||
}, | ||
walkthrough: { | ||
description: ` | ||
<p> | ||
This static operator is useful for creating a simple Observable that only emits the arguments given, | ||
and the complete notification thereafter. It can be used for composing with other Observables, | ||
such as with concat. By default, it uses a null IScheduler, which means the next notifications | ||
are sent synchronously, although with a different IScheduler it is possible to determine | ||
when those notifications will be delivered.</p> | ||
` | ||
}, | ||
examples: [ | ||
{ | ||
name: `Emit 10, 20, 30, then 'a', 'b', 'c', then start ticking every second.`, | ||
code: ` | ||
import { of } from 'rxjs/observable/of'; | ||
import { interval } from 'rxjs/observable/interval'; | ||
import { concat } from 'rxjs/operators'; | ||
|
||
const numbers = of(10, 20, 30); | ||
const letters = of('a', 'b', 'c'); | ||
const interval = interval(1000); | ||
const result = numbers.pipe( | ||
concat(letters), | ||
concat(interval)); | ||
result.subscribe(x => console.log(x));`, | ||
// 10 | ||
// 20 | ||
// 30 | ||
// 'a' | ||
// 'b' | ||
// 'c' | ||
// 0 | ||
// 1 | ||
// 2 | ||
// ... | ||
externalLink: { | ||
platform: 'JSBin', | ||
url: 'http://jsbin.com/porolatazu/embed?js,output' | ||
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 we want console, not output in the embed |
||
} | ||
} | ||
] | ||
}; |
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.
Few things:
interval
concat
'sWith update it would look something like:
StackBlitz
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.
thanks for the feedback. Changes are pushed!