Skip to content
This repository has been archived by the owner on Oct 1, 2018. It is now read-only.

Commit

Permalink
Merge pull request #194 from ashwin-sureshkumar/issue-97
Browse files Browse the repository at this point in the history
docs(operators): add documentation for skip
  • Loading branch information
sumitarora authored Dec 11, 2017
2 parents 1314af3 + 6983019 commit f77497f
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions src/operator-docs/filtering/skip.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
import { OperatorDoc } from '../operator.model';

export const skip: OperatorDoc = {
'name': 'skip',
'operatorType': 'filtering'
name: 'skip',
operatorType: 'filtering',
signature: 'public skip(count: Number): Observable',
parameters: [
{
name: 'count',
type: 'Number',
attribute: '',
description:
'Returns an Observable that skips the first count items emitted by the source Observable.'
}
],
marbleUrl: 'http://reactivex.io/rxjs/img/skip.png',
shortDescription: {
description:
'Returns an Observable that skips the first count items emitted by the source Observable.'
},
examples: [
{
name: 'Skipping values before emission',
code: `
//emit every 1s
const source = Rx.Observable.interval(1000);
//skip the first 5 emitted values
const example = source.skip(5);
//output: 5...6...7...8........
const subscribe = example.subscribe(val => console.log(val));
`,
externalLink: {
platform: 'JSBin',
url: 'http://jsbin.com/hacepudabi/1/embed?js,console'
}
}
]
};

0 comments on commit f77497f

Please sign in to comment.