metadata
title: Atomics.load()
short-title: load()
slug: Web/JavaScript/Reference/Global_Objects/Atomics/load
page-type: javascript-static-method
browser-compat: javascript.builtins.Atomics.load
sidebar: jsref
The Atomics.load() static
method returns a value at a given position in the array.
{{InteractiveExample("JavaScript Demo: Atomics.load()")}}
// Create a SharedArrayBuffer with a size in bytes
const buffer = new SharedArrayBuffer(16);
const uint8 = new Uint8Array(buffer);
uint8[0] = 5;
// 5 + 2 = 7
console.log(Atomics.add(uint8, 0, 2));
// Expected output: 5
console.log(Atomics.load(uint8, 0));
// Expected output: 7
Syntax
Atomics.load(typedArray, index)
Parameters
typedArray- : An integer typed array. One of {{jsxref("Int8Array")}}, {{jsxref("Uint8Array")}}, {{jsxref("Int16Array")}}, {{jsxref("Uint16Array")}}, {{jsxref("Int32Array")}}, {{jsxref("Uint32Array")}}, {{jsxref("BigInt64Array")}}, or {{jsxref("BigUint64Array")}}.
index- : The position in the
typedArrayto load from.
- : The position in the
Return value
The value at the given position (typedArray[index]).
Exceptions
- {{jsxref("TypeError")}}
- : Thrown if
typedArrayis not one of the allowed integer types.
- : Thrown if
- {{jsxref("RangeError")}}
- : Thrown if
indexis out of bounds in thetypedArray.
- : Thrown if
Examples
Using load
const sab = new SharedArrayBuffer(1024);
const ta = new Uint8Array(sab);
Atomics.add(ta, 0, 12);
Atomics.load(ta, 0); // 12
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- {{jsxref("Atomics")}}
- {{jsxref("Atomics.store()")}}