Iterator.prototype.flatMap()

实验性： 这是一个实验性技术
在生产环境中使用此功能之前，请仔细查看浏览器兼容性表格。

flatMap() 方法是 Iterator 实例的方法，它返回一个新的迭代器助手，该助手获取原始迭代器中的每个元素，将其传递给映射函数，并产生映射函数返回的元素（这些元素包含在另一个迭代器或可迭代对象中）。

语法

flatMap(callbackFn)

参数

callbackFn

为迭代器生成的每个元素执行的函数。它应该返回一个迭代器或可迭代对象，该对象产生 flatMap() 要产生的元素。请注意，与 Array.prototype.flatMap() 不同，您不能返回单个非迭代器/可迭代值。该函数使用以下参数调用

element: 正在处理的数组中的当前元素。
index: 正在处理的数组中的当前元素的索引。

一个新的迭代器助手。第一次调用迭代器助手的 next() 方法时，它会对基础迭代器产生的第一个元素调用 callbackFn，并且返回值（应该是迭代器或可迭代对象）会由迭代器助手逐一产生（类似于 yield*）。当 callbackFn 返回的先前元素完成时，会从基础迭代器中获取下一个元素。当基础迭代器完成时，迭代器助手也完成（next() 方法产生 { value: undefined, done: true }）。

异常

TypeError: 如果 callbackFn 返回非迭代器/可迭代值或字符串基本类型，则抛出此异常。

描述

flatMap 接受来自 callbackFn 的两种返回值：迭代器或可迭代对象。它们与 Iterator.from() 的处理方式相同：如果返回值是可迭代的，则调用 [Symbol.iterator]() 方法并使用返回值；否则，返回值被视为迭代器，并调用其 next() 方法。

[1, 2, 3]
  .values()
  .flatMap((x) => {
    let itDone = false;
    const it = {
      next() {
        if (itDone) {
          return { value: undefined, done: true };
        }
        itDone = true;
        return { value: x, done: false };
      },
    };
    switch (x) {
      case 1:
        // An iterable that's not an iterator
        return { [Symbol.iterator]: () => it };
      case 2:
        // An iterator that's not an iterable
        return it;
      case 3:
        // An iterable iterator is treated as an iterable
        return {
          ...it,
          [Symbol.iterator]() {
            console.log("Symbol.iterator called");
            return it;
          },
        };
    }
  })
  .toArray();
// Logs "Symbol.iterator called"
// Returns [1, 2, 3]

示例

合并映射

以下示例将两个 Map 对象合并为一个

const map1 = new Map([
  ["a", 1],
  ["b", 2],
  ["c", 3],
]);
const map2 = new Map([
  ["d", 4],
  ["e", 5],
  ["f", 6],
]);

const merged = new Map([map1, map2].values().flatMap((x) => x));
console.log(merged.get("a")); // 1
console.log(merged.get("e")); // 5

这避免了创建映射内容的任何临时副本。请注意，数组 [map1, map2] 必须首先转换为迭代器（使用 Array.prototype.values()），因为 Array.prototype.flatMap() 仅展平数组，而不是可迭代对象。

new Map([map1, map2].flatMap((x) => x)); // Map(1) {undefined => undefined}

返回字符串

字符串是可迭代的，但 flatMap() 特别拒绝 callbackFn 返回的字符串基本类型，这是因为按代码点进行迭代的行为通常不是您想要的。

[1, 2, 3]
  .values()
  .flatMap((x) => String(x))
  .toArray(); // TypeError: Iterator.prototype.flatMap called on non-object

您可能希望将其包装在数组中，以便整个字符串作为单个元素产生

[1, 2, 3]
  .values()
  .flatMap((x) => [String(x)])
  .toArray(); // ['1', '2', '3']

或者，如果想要按代码点进行迭代的行为，可以使用 Iterator.from() 将其转换为正确的迭代器

[1, 2, 3]
  .values()
  .flatMap((x) => Iterator.from(String(x * 10)))
  .toArray();
// ['1', '0', '2', '0', '3', '0']

规范

规范
迭代器助手 # sec-iteratorprototype.flatmap

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅

core-js 中 Iterator.prototype.flatMap 的 polyfill