Atomics.add()
The static Atomics.add()
method adds a given value at a given position in the array and returns the old value at
that position. This atomic operation guarantees that no other write happens until the
modified value is written back.
Syntax
Atomics.add(typedArray, index, value)
Parameters
typedArray
-
An integer typed array. One of
Int8Array
,Uint8Array
,Int16Array
,Uint16Array
,Int32Array
,Uint32Array
,BigInt64Array
, orBigUint64Array
. index
-
The position in the
typedArray
to add avalue
to. value
-
The number to add.
Return value
The old value at the given position
(typedArray[index]
).
Exceptions
-
Throws a
TypeError
, iftypedArray
is not one of the allowed integer types. -
Throws a
RangeError
, ifindex
is out of bounds in thetypedArray
.
Examples
Using add()
const sab = new SharedArrayBuffer(1024);
const ta = new Uint8Array(sab);
Atomics.add(ta, 0, 12); // returns 0, the old value
Atomics.load(ta, 0); // 12
Specifications
Specification |
---|
ECMAScript Language Specification # sec-atomics.add |
Browser compatibility
BCD tables only load in the browser