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 ignoreElements #301
Open
saiprasad2595
wants to merge
4
commits into
ReactiveX:master
Choose a base branch
from
saiprasad2595:ignoreElements
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
4 commits
Select commit
Hold shift + click to select a range
362b126
docs (operators): add documentation for ignoreElements
saiprasad2595 0444068
Merge branch 'master' into ignoreElements
saiprasad2595 690c8ff
docs(operators): markdown class added
saiprasad2595 884e75f
docs(operators): flatMap to mergeMap updated
saiprasad2595 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,67 @@ | ||
import { OperatorDoc } from '../operator.model'; | ||
|
||
export const ignoreElements: OperatorDoc = { | ||
'name': 'ignoreElements', | ||
'operatorType': 'filtering' | ||
name: 'ignoreElements', | ||
operatorType: 'filtering', | ||
signature: 'public ignoreElements(): OperatorFunction<any, never>', | ||
marbleUrl: 'http://reactivex.io/rxjs/img/ignoreElements.png', | ||
shortDescription: { | ||
description: | ||
'Ignores all items emitted by the source Observable and only passes calls of `complete` or `error`' | ||
}, | ||
walkthrough: { | ||
description: `<p> | ||
<span class="markdown-code">ignoreElements</span> | ||
Returns an empty Observable that only calls 'complete' or 'error', based on which one is called by source Observable | ||
</p>` | ||
}, | ||
examples: [ | ||
{ | ||
name: 'Ignores all elements from source', | ||
code: ` | ||
import { interval } from 'rxjs/observable/interval'; | ||
import { take, ignoreElements } from 'rxjs/operators'; | ||
//emit value every 100ms | ||
const source = interval(100); | ||
//ignore everything but complete | ||
const example = source.pipe(take(5), ignoreElements()); | ||
//output: "COMPLETE!" | ||
const subscribe = example.subscribe( | ||
val => console.log('NEXT:',val), | ||
val => console.log('ERROR:',val), | ||
() => console.log('COMPLETE!') | ||
); | ||
`, | ||
externalLink: { | ||
platform: 'JSBin', | ||
url: 'http://jsbin.com/yiyefelubi/1/edit?js,console' | ||
} | ||
}, | ||
{ | ||
name: 'Displaying Error', | ||
code: ` | ||
//emit value every 100ms | ||
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. Would you be able to update this to pipeable operators and remove global? Thanks! |
||
const source = Rx.Observable.interval(100); | ||
//ignore everything but error | ||
const error = source | ||
.flatMap(val => { | ||
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. Maybe use |
||
if(val === 4){ | ||
return Rx.Observable.throw('ERROR AT'val); | ||
} | ||
return Rx.Observable.of(val); | ||
}) | ||
.ignoreElements(); | ||
//output: "ERROR: ERROR AT 4" | ||
const subscribe = error.subscribe( | ||
val => console.log('NEXT:',val), | ||
val => console.log('ERROR:',val), | ||
() => console.log('SECOND COMPLETE!') | ||
); | ||
`, | ||
externalLink: { | ||
platform: 'JSBin', | ||
url: 'http://jsbin.com/gogonawuze/1/edit?js,console' | ||
} | ||
} | ||
] | ||
}; |
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.
May need to remove backticks here and use
markdown-code
class.