Skip to content

Commit

Permalink
Deprecate toPromise. (#5403)
Browse files Browse the repository at this point in the history
* Deprecate toPromise. 

Link to firstValueFrom or lastValueFrom instead.

* Update Observable.ts
  • Loading branch information
Christine Legge committed Jun 9, 2020
1 parent 98ad0eb commit aa9ab6b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/internal/Observable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,11 @@ export class Observable<T> implements Subscribable<T> {
}

/* tslint:disable:max-line-length */
/** @deprecated Deprecated use {@link firstValueFrom} or {@link lastValueFrom} instead */
toPromise<T>(this: Observable<T>): Promise<T | undefined>;
/** @deprecated Deprecated use {@link firstValueFrom} or {@link lastValueFrom} instead */
toPromise<T>(this: Observable<T>, PromiseCtor: typeof Promise): Promise<T | undefined>;
/** @deprecated Deprecated use {@link firstValueFrom} or {@link lastValueFrom} instead */
toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T | undefined>;
/* tslint:enable:max-line-length */

Expand All @@ -363,6 +366,7 @@ export class Observable<T> implements Subscribable<T> {
* @return A Promise that resolves with the last value emit, or
* rejects on an error. If there were no emissions, Promise
* resolves with undefined.
* @deprecated Deprecated use {@link firstValueFrom} or {@link lastValueFrom} instead
*/
toPromise(promiseCtor?: PromiseConstructorLike): Promise<T | undefined> {
promiseCtor = getPromiseCtor(promiseCtor);
Expand Down Expand Up @@ -412,4 +416,4 @@ export interface Observable<T> {
return asyncIteratorFrom(this);
};
}
})();
})();

0 comments on commit aa9ab6b

Please sign in to comment.