Skip to content
This repository was archived by the owner on Oct 1, 2018. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions src/operator-docs/filtering/skipUntil.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
import { OperatorDoc } from '../operator.model';

export const skipUntil: OperatorDoc = {
'name': 'skipUntil',
'operatorType': 'filtering'
name: 'skipUntil',
operatorType: 'filtering',
signature: 'public skipUntil(notifier: Observable): Observable<T>',
parameters: [
{
name: 'notifier',
type: 'Observable',
attribute: '',
description: `The second Observable that has to emit an item before
the source Observable's elements begin to be mirrored by the resulting Observable.`
}
],
marbleUrl: 'http://reactivex.io/rxjs/img/skipUntil.png',
shortDescription: {
description:
'Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.'
},
examples: [
{
name: 'Emits every 1s after 5 seconds',
code: `
//emit every 1s
const source = Rx.Observable.interval(1000);
//skip emitted values from source until inner observable emits (6s)
const example = source.skipUntil(Rx.Observable.timer(6000));
//output: 5...6...7...8........
const subscribe = example.subscribe(val => console.log(val));
`,
externalLink: {
platform: 'JSBin',
url: 'http://jsbin.com/tapizososu/embed?js,console,output'
}
}
]
};