Atomics.load

The static Atomics.load() method returns a value at a given position in the array. This atomic operation guarantees that no other read happens until the modified value is read back.

Syntax

Atomics.load(typedArray, index)

Parameters

typedArray

A shared integer typed array. One of Int8Array, Uint8Array, Int16Array, Uint16Array, Int32Array, or Uint32Array.

index

The position in the typedArray to load from.

Return value

The value at the given position (typedArray[index]).

Exceptions

• Throws a TypeError, if typedArray is not one of the allowed integer types.
• Throws a TypeError, if typedArray is not a shared typed array type.
• Throws a RangeError, if index is out of bounds in the typedArray.

Examples

var sab = new SharedArrayBuffer(1024);
var ta = new Uint8Array(sab);

Atomics.add(ta, 0, 12);
Atomics.load(ta, 0); // 12

Specifications

Specification	Status	Comment
ECMAScript Shared Memory and Atomics The definition of 'Atomics.load' in that specification.	Draft	Initial definition.

Browser compatibility

[1] In Firefox version 46 until version 51, this feature was disabled by a preference setting. In about:config, set javascript.options.shared_memory to true.

[2] The implementation is under development and needs these runtime flags: --js-flags=--harmony-sharedarraybuffer --enable-blink-feature=SharedArrayBuffer

See also

• Atomics
• Atomics.store()