TypedArray.prototype.set()

Baseline Widely available

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

The set() method of TypedArray instances stores multiple values in the typed array, reading input values from a specified array.

Try it

Syntax

js
set(array)
set(array, targetOffset)

set(typedarray)
set(typedarray, targetOffset)

Parameters

array

The array from which to copy values. All values from the source array are copied into the target array, unless the length of the source array plus the target offset exceeds the length of the target array, in which case an exception is thrown.

typedarray

If the source array is a typed array, the two arrays may share the same underlying ArrayBuffer; the JavaScript engine will intelligently copy the source range of the buffer to the destination range.

targetOffset Optional

The offset into the target array at which to begin writing values from the source array. If this value is omitted, 0 is assumed (that is, the source array will overwrite values in the target array starting at index 0).

Return value

None (undefined).

Exceptions

RangeError

Thrown in one of the following cases:

  • An element will be stored beyond the end of the typed array, either because targetOffset is too large or because array or typedarray is too large.
  • targetOffset is negative.

Examples

Using set()

js
const buffer = new ArrayBuffer(8);
const uint8 = new Uint8Array(buffer);

uint8.set([1, 2, 3], 3);

console.log(uint8); // Uint8Array [ 0, 0, 0, 1, 2, 3, 0, 0 ]

Specifications

Specification
ECMAScript Language Specification
# sec-%typedarray%.prototype.set

Browser compatibility

BCD tables only load in the browser

See also