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

Commit 8804ed5

Browse files
Merge pull request #183 from sumitarora/docs-startWith
docs(operators): add documentation for startWith
2 parents 5cf7fc6 + 916221b commit 8804ed5

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed
Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
import { OperatorDoc } from '../operator.model';
22

33
export const startWith: OperatorDoc = {
4-
'name': 'startWith',
5-
'operatorType': 'combination'
4+
name: 'startWith',
5+
operatorType: 'combination',
6+
marbleUrl: 'http://reactivex.io/rxjs/img/startWith.png',
7+
signature: 'public startWith(values: ...T, scheduler: Scheduler): Observable',
8+
shortDescription: {
9+
description:
10+
'Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.'
11+
},
12+
parameters: [
13+
{
14+
name: 'values',
15+
type: '...T',
16+
attribute: '',
17+
description: 'Items you want the modified Observable to emit first.'
18+
},
19+
{
20+
name: 'scheduler',
21+
type: 'Scheduler',
22+
attribute: 'optional',
23+
description:
24+
'A IScheduler to use for scheduling the emissions of the next notifications.'
25+
}
26+
]
627
};

0 commit comments

Comments
 (0)