Skip to content

update toPromise documentation with undefined #5310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cartant merged 1 commit into from
Feb 16, 2020
Merged

update toPromise documentation with undefined #5310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/internal/Observable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,13 +354,14 @@ export class Observable<T> implements Subscribable<T> {

/**
* Subscribe to this Observable and get a Promise resolving on
* `complete` with the last emission.
* `complete` with the last emission (if any).
*
* @method toPromise
* @param [promiseCtor] a constructor function used to instantiate
* the Promise
* @return A Promise that resolves with the last value emit, or
* rejects on an error.
* rejects on an error. If there were no emissions, Promise
* resolves with undefined.
*/
toPromise(promiseCtor?: PromiseConstructorLike): Promise<T | undefined> {
promiseCtor = getPromiseCtor(promiseCtor);
Expand Down