Promise.allSettledKeyed()

構文

Promise.allSettledKeyed(object)

引数

object

オブジェクト。そのすべての自身の列挙可能なプロパティは、キーが文字列であるかシンボルであるかを問わず、Promise の値を持つ必要があります。これらの値は await されるため、それ以外の thenable も解決されますが、thenable でないものはそのまま返されます。

結果

次のような Promise です。

• 渡された object に自身の列挙可能なプロパティがない場合は、履行済みになります。

• 指定された object 内のすべてのプロミスが決定（履行または拒否）された場合は、非同期に履行されます。履行値はオブジェクトであり、指定された object と同じキーを同じ順序で持ち、それぞれのプロパティの値は、完了順序に関係なく、object 内の対応するプロミスの結果を表します。それぞれの結果オブジェクトには、以下のプロパティがあります。

  status

  プロミスの最終的な状態を示す文字列で、"fulfilled" または "rejected" のどちらかです。

  value

  status が "fulfilled" の場合にのみ存在します。プロミスの履行値です。

  reason

  status が "rejected" の場合にのみ存在します。プロミスが拒否された理由です。。

  渡された object が空ではないものの、待機中のプロミスが含まれていない場合でも、返されるプロミスは同期的ではなく、非同期で履行されます。

解説

Promise.allSettledKeyed() メソッドは、プロミス並行処理に関連するメソッドの一つです。これは Promise.allSettled() と同様の処理を行います。Promise.allSettledKeyed() は、プロミスの配列をまだ持っていない場合や、結果を直ちに構造分解したい場合にお勧めです。詳細については、Promise.allKeyed() を参照してください。

例

Promise.allSettledKeyed() の使用

Promise.allSettledKeyed() メソッドは、オブジェクトを受け取り、そのオブジェクトの自分自身で列挙可能なプロパティをすべて処理します。

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

const sym = Symbol("example");

const promises = {
  a: delayed("a", 500),
  // シンボルのプロパティは処理される
  [sym]: delayed("symbol", 300),
  // 入れ子になったプロパティは処理されず、このオブジェクト全体が
  // すでに解決値として扱われ、そのまま返される
  nested: {
    b: delayed("b", 100),
  },
};

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

Promise.allSettled() および Promise.allSettledKeyed() に共通する並行処理の挙動に関するその他の例については、Promise.allSettled() を参照してください。

仕様書

ブラウザーの互換性

関連情報

• Promise.allSettledKeyed のポリフィル (core-js)
• es-shims による Promise.allSettledKeyed のポリフィル
• Promise
• Promise.allKeyed()
• Promise.allSettled()