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

Commit f77497f

Browse files
authored
Merge pull request #194 from ashwin-sureshkumar/issue-97
docs(operators): add documentation for skip
2 parents 1314af3 + 6983019 commit f77497f

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

src/operator-docs/filtering/skip.ts

+34-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,38 @@
11
import { OperatorDoc } from '../operator.model';
22

33
export const skip: OperatorDoc = {
4-
'name': 'skip',
5-
'operatorType': 'filtering'
4+
name: 'skip',
5+
operatorType: 'filtering',
6+
signature: 'public skip(count: Number): Observable',
7+
parameters: [
8+
{
9+
name: 'count',
10+
type: 'Number',
11+
attribute: '',
12+
description:
13+
'Returns an Observable that skips the first count items emitted by the source Observable.'
14+
}
15+
],
16+
marbleUrl: 'http://reactivex.io/rxjs/img/skip.png',
17+
shortDescription: {
18+
description:
19+
'Returns an Observable that skips the first count items emitted by the source Observable.'
20+
},
21+
examples: [
22+
{
23+
name: 'Skipping values before emission',
24+
code: `
25+
//emit every 1s
26+
const source = Rx.Observable.interval(1000);
27+
//skip the first 5 emitted values
28+
const example = source.skip(5);
29+
//output: 5...6...7...8........
30+
const subscribe = example.subscribe(val => console.log(val));
31+
`,
32+
externalLink: {
33+
platform: 'JSBin',
34+
url: 'http://jsbin.com/hacepudabi/1/embed?js,console'
35+
}
36+
}
37+
]
638
};

0 commit comments

Comments
 (0)