forked from ReactiveX/rxjs-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request ReactiveX#183 from sumitarora/docs-startWith
docs(operators): add documentation for startWith
- Loading branch information
Showing
1 changed file
with
23 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.' | ||
} | ||
] | ||
}; |