W3cubDocs

Atomics.sub()

The Atomics.sub() static method subtracts 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.

Try it

Syntax

Atomics.sub(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 subtract a value from.
value: The number to subtract.

Return value

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

Exceptions

TypeError: Thrown if typedArray is not one of the allowed integer types.
RangeError: Thrown if index is out of bounds in the typedArray.

Examples

Using sub

const sab = new SharedArrayBuffer(1024);
const ta = new Uint8Array(sab);
ta[0] = 48;

Atomics.sub(ta, 0, 12); // returns 48, the old value
Atomics.load(ta, 0); // 36

Specifications

Specification
ECMAScript Language Specification # sec-atomics.sub

Browser compatibility

	Desktop						Mobile						Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	Deno	Node.js
`sub`	68	79	78	55	15.2	89	79	63	15.2	15.0	89	1.0	8.10.0