The Atomics.add()
static
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, or BigUint64Array.
index
- : The position in the
typedArray
to add avalue
to.
- : The position in the
value
- : The number to add.
Return value
The old value at the given position
(typedArray[index]
).
Exceptions
- TypeError
- : Thrown if
typedArray
is not one of the allowed integer types.
- : Thrown if
- RangeError
- : Thrown if
index
is out of bounds in thetypedArray
.
- : Thrown if
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