Promise.allKeyed()

Syntax

Promise.allKeyed(object)

Parameters

object

An object. All of its own enumerable properties, whether the key is a string or a symbol, should have Promise values. These values are awaited, so other thenables are also resolved, while non-thenables are returned as-is.

Return value

A Promise that is:

• Already fulfilled, if the object passed has no own enumerable properties.
• Asynchronously fulfilled, when all the promises in the given object fulfill. The fulfillment value is an object of fulfillment values, with the same keys in the same order as the given object, regardless of completion order. If the object passed is non-empty but contains no pending promises, the returned promise is still asynchronously (instead of synchronously) fulfilled.
• Asynchronously rejected, when any of the promises in the given object rejects. The rejection reason is the rejection reason of the first promise that was rejected.

Description

The Promise.allKeyed() method is one of the promise concurrency methods. It performs the same kind of task as Promise.all(). However, a lot of the times, you don't already have an array of promises and instead just have a few ad-hoc operations to batch up, so you put them in an array and then immediately destructure:

const [resultA, resultB, resultC] = await Promise.all([getA(), getB(), getC()]);

The problem with this is that you need to maintain the consistency of ordering on both sides: if you accidentally write [resultA, resultC, resultB], your code will break.

The keyed method mitigates the problem by associating each async operation with a semantic key:

const {
  a: resultA,
  b: resultB,
  c: resultC,
} = await Promise.allKeyed({
  a: getA(),
  b: getB(),
  c: getC(),
});

This way, the ordering no longer matters, and any name mismatch is local: accidentally writing b: resultC is now much easier to catch!

Examples

Using Promise.allKeyed()

The Promise.allKeyed() method takes an object and processes all of its own enumerable properties.

function delayed(value, timeout) {
  return new Promise((res) => setTimeout(() => res(value), timeout));
}

const sym = Symbol();

const promises = {
  a: delayed("a", 500),
  // Symbol properties are processed
  [sym]: delayed("symbol", 300),
  // Nested properties are not processed; this whole object is treated as
  // an already-resolved value and returned as-is
  nested: {
    b: delayed("b", 100),
  },
};

const result = await Promise.allKeyed(promises);
console.log(result);
// {
//   a: "a",
//   [sym]: "symbol",
//   nested: {
//     b: <Promise>,
//   },
// }

For more examples related to concurrency behavior common to Promise.all() and Promise.allKeyed(), see Promise.all().

Specifications

Browser compatibility

See also

• Polyfill of Promise.allKeyed in core-js
• es-shims polyfill of Promise.allKeyed
• Promise
• Promise.allSettledKeyed()
• Promise.all()