Skip to content

Commit

Permalink
Merge pull request ReactiveX#183 from sumitarora/docs-startWith
Browse files Browse the repository at this point in the history
docs(operators): add documentation for startWith
  • Loading branch information
ashwin-sureshkumar authored Dec 6, 2017
2 parents 5cf7fc6 + 916221b commit 8804ed5
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions src/operator-docs/combination/startWith.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
import { OperatorDoc } from '../operator.model';

export const startWith: OperatorDoc = {
'name': 'startWith',
'operatorType': 'combination'
name: 'startWith',
operatorType: 'combination',
marbleUrl: 'http://reactivex.io/rxjs/img/startWith.png',
signature: 'public startWith(values: ...T, scheduler: Scheduler): Observable',
shortDescription: {
description:
'Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.'
},
parameters: [
{
name: 'values',
type: '...T',
attribute: '',
description: 'Items you want the modified Observable to emit first.'
},
{
name: 'scheduler',
type: 'Scheduler',
attribute: 'optional',
description:
'A IScheduler to use for scheduling the emissions of the next notifications.'
}
]
};

0 comments on commit 8804ed5

Please sign in to comment.