Array.prototype.copyWithin()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.

copyWithin() 方法浅复制数组的一部分到同一数组中的另一个位置，并返回它，不会改变原数组的长度。

尝试一下

语法

js
copyWithin(target)
copyWithin(target, start)
copyWithin(target, start, end)

参数

target

序列开始替换的目标位置，以 0 为起始的下标表示，且将被转换为整数

  • 负索引将从数组末尾开始计数——如果 target < 0，则实际是 target + array.length。
  • 如果 target < -array.length，则使用 0。
  • 如果 target >= array.length，则不会拷贝任何内容。
  • 如果 target 位于 start 之后，则复制只会持续到 array.length 结束（换句话说，copyWithin() 永远不会扩展数组）。
start 可选

要复制的元素序列的起始位置，以 0 为起始的下标表示，且将被转换为整数

  • 负索引将从数组末尾开始计数——如果 start < 0，则实际是 start + array.length。
  • 如果省略 start 或 start < -array.length，则默认为 0。
  • 如果 start >= array.length，则不会拷贝任何内容。
end 可选

要复制的元素序列的结束位置，以 0 为起始的下标表示，且将被转换为整数。copyWithin 将会拷贝到该位置，但不包括 end 这个位置的元素。

  • 负索引将从数组末尾开始计数——如果 end < 0，则实际是 end + array.length。
  • 如果 end < -array.length，则使用0。
  • 如果省略 end 或 end >= array.length，则默认为 array.length，这将导致直到数组末尾的所有元素都被复制。
  • 如果 end 位于 start 之前，则不会拷贝任何内容。

返回值

改变后的数组。

描述

copyWithin() 方法的工作原理类似于 C 和 C++ 的 memmove，是一种移动数组数据的高性能方法，与 TypedArray 的同名方法类似。序列在一次中操作被复制和粘贴；即使复制和粘贴区域重叠，粘贴的序列也将具有复制值。

copyWithin() 是修改方法。它不会改变 this 指向的对象（数组或类数组）的长度，但会更改其的内容，并在必要时创建新属性或删除现有属性。

copyWithin() 方法保留空槽。如果要复制的区域是稀疏的，则原来的空槽会被删除并被替换为拷贝的空槽。

copyWithin() 方法是通用的。它只期望 this 值具有 length 属性和整数键属性。虽然字符串也是类似数组的，但这种方法不适用于它们，因为字符串是不可变的。

示例

使用 copyWithin()

js
console.log([1, 2, 3, 4, 5].copyWithin(-2));
// [1, 2, 3, 1, 2]

console.log([1, 2, 3, 4, 5].copyWithin(0, 3));
// [4, 5, 3, 4, 5]

console.log([1, 2, 3, 4, 5].copyWithin(0, 3, 4));
// [4, 2, 3, 4, 5]

console.log([1, 2, 3, 4, 5].copyWithin(-2, -3, -1));
// [1, 2, 3, 3, 4]

在稀疏数组上使用 copyWithin()

copyWithin() 将保留空插槽。

js
console.log([1, , 3].copyWithin(2, 1, 2)); // [1, empty, empty]

在非数组对象上调用 copyWithin()

copyWithin() 方法读取 this 的 length 属性，然后操作所涉及的整数索引。

js
const arrayLike = {
  length: 5,
  3: 1,
};
console.log(Array.prototype.copyWithin.call(arrayLike, 0, 3));
// { '0': 1, '3': 1, length: 5 }
console.log(Array.prototype.copyWithin.call(arrayLike, 3, 1));
// { '0': 1, length: 5 }
// '3' 属性被删除，因为在复制的源中是一个空槽

规范

Specification
ECMAScript Language Specification
# sec-array.prototype.copywithin

浏览器兼容性

BCD tables only load in the browser

参见