Skip to content

Commit

Permalink
docs(Observable): update forEach jsdoc to include PromiseCtor
Browse files Browse the repository at this point in the history
- fix typo in jsdoc lift params for `operator`
  • Loading branch information
gjungb authored and benlesh committed Sep 23, 2015
1 parent f72e622 commit 4515fff
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/Observable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export default class Observable<T> {
* @param {Function} subscribe the function that is
* called when the Observable is initially subscribed to. This function is given a Subscriber, to which new values
* can be `next`ed, or an `error` method can be called to raise an error, or `complete` can be called to notify
* of a succesful completion.
* of a successful completion.
*/
constructor(subscribe?: <R>(subscriber: Subscriber<R>) => Subscription<T>|Function|void) {
if (subscribe) {
Expand All @@ -52,7 +52,7 @@ export default class Observable<T> {

/**
* @method lift
* @param {Operator} the operator defining the operation to take on the observable
* @param {Operator} operator the operator defining the operation to take on the observable
* @returns {Observable} a new observable with the Operator applied
* @description creates a new Observable, with this Observable as the source, and the passed
* operator defined as the new observable's operator.
Expand Down Expand Up @@ -109,6 +109,7 @@ export default class Observable<T> {
/**
* @method forEach
* @param {Function} next a handler for each value emitted by the observable
* @param {PromiseConstructor} PromiseCtor? a constructor function used to instantiate the Promise
* @returns {Promise} a promise that either resolves on observable completion or
* rejects with the handled error
*/
Expand Down

0 comments on commit 4515fff

Please sign in to comment.