This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The static Atomics.sub() method substracts 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.sub(typedArray, index, value)
Parameters
typedArray- A shared integer typed array. One of
Int8Array,Uint8Array,Int16Array,Uint16Array,Int32Array, orUint32Array. index- The position in the
typedArrayto subtract avaluefrom. value- The number to subtract.
Return value
The old value at the given position (typedArray[index]).
Exceptions
- Throws a
TypeError, iftypedArrayis not one of the allowed integer types. - Throws a
TypeError, iftypedArrayis not a shared typed array type. - Throws a
RangeError, ifindexis out of bounds in thetypedArray.
Examples
var sab = new SharedArrayBuffer(1024); var ta = new Uint8Array(sab); ta[0] = 48; Atomics.sub(ta, 0, 12); // returns 48, the old value Atomics.load(ta, 0); // 36
Specifications
| Specification | Status | Comment |
|---|---|---|
| ECMAScript Latest Draft (ECMA-262) The definition of 'Atomics.sub' in that specification. |
Draft | Initial definition in ES2017. |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | No support [2] | No support | 55 (55) [1] | No support | No support | No support |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | No support | No support | 55.0 (55) [1] | No support | No support | No support |
[1] In Firefox version 46 until version 54, this feature is disabled by a preference setting. In about:config, set javascript.options.shared_memory to true.
[2] The implementation is under development and needs these runtime flags: --js-flags=--harmony-sharedarraybuffer --enable-blink-feature=SharedArrayBuffer