File size: 1,935 Bytes
780c9fe | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | ---
title: Atomics.sub()
short-title: sub()
slug: Web/JavaScript/Reference/Global_Objects/Atomics/sub
page-type: javascript-static-method
browser-compat: javascript.builtins.Atomics.sub
sidebar: jsref
---
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.
{{InteractiveExample("JavaScript Demo: Atomics.sub()")}}
```js interactive-example
// Create a SharedArrayBuffer with a size in bytes
const buffer = new SharedArrayBuffer(16);
const uint8 = new Uint8Array(buffer);
uint8[0] = 7;
// 7 - 2 = 5
console.log(Atomics.sub(uint8, 0, 2));
// Expected output: 7
console.log(Atomics.load(uint8, 0));
// Expected output: 5
```
## Syntax
```js-nolint
Atomics.sub(typedArray, index, value)
```
### 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 `typedArray` to subtract a
`value` from.
- `value`
- : The number to subtract.
### Return value
The old value at the given position
(`typedArray[index]`).
### Exceptions
- {{jsxref("TypeError")}}
- : Thrown if `typedArray` is not one of the allowed integer types.
- {{jsxref("RangeError")}}
- : Thrown if `index` is out of bounds in the `typedArray`.
## Examples
### Using sub
```js
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
{{Specifications}}
## Browser compatibility
{{Compat}}
## See also
- {{jsxref("Atomics")}}
- {{jsxref("Atomics.add()")}}
|