Promise.resolve vs new Promise(resolve)

Pipo picture Pipo · Nov 3, 2014 · Viewed 35.3k times · Source

I'm using bluebird and I see two ways to resolve synchronous functions into a Promise, but I don't get the differences between both ways. It looks like the stacktrace is a little bit different, so they aren't just an alias, right?

So what is the preferred way?

Way A

function someFunction(someObject) {
  return new Promise(function(resolve) {
    someObject.resolved = true;
    resolve(someObject);
  });
}

Way B

function someFunction(someObject) {
  someObject.resolved = true;
  return Promise.resolve(someObject);
}

Answer

Benjamin Gruenbaum picture Benjamin Gruenbaum · Nov 3, 2014

Contrary to both answers in the comments - there is a difference.

While

Promise.resolve(x);

is basically the same as

new Promise(function(r){ r(x); });

there is a subtlety.

Promise returning functions should generally have the guarantee that they should not throw synchronously since they might throw asynchronously. In order to prevent unexpected results and race conditions - throws are usually converted to returned rejections.

With this in mind - when the spec was created the promise constructor is throw safe.

What if someObject is undefined?

  • Way A returns a rejected promise.
  • Way B throws synchronously.

Bluebird saw this, and Petka added Promise.method to address this issue so you can keep using return values. So the correct and easiest way to write this in Bluebird is actually neither - it is:

var someFunction = Promise.method(function someFunction(someObject){
    someObject.resolved = true;
    return someObject;
});

Promise.method will convert throws to rejects and returns to resolves for you. It is the most throw safe way to do this and it assimilatesthenables through return values so it'd work even if someObject is in fact a promise itself.

In general, Promise.resolve is used for casting objects and foreign promises (thenables) to promises. That's its use case.