Expand description
The Atomics object provides atomic operations as static methods.
They are used with SharedArrayBuffer objects.
The Atomic operations are installed on an Atomics module. Unlike
the other global objects, Atomics is not a constructor. You cannot
use it with a new operator or invoke the Atomics object as a
function. All properties and methods of Atomics are static
(as is the case with the Math object, for example).
MDN documentation
Functions
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.
The static Atomics.and() method computes a bitwise AND with 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.
The static Atomics.compareExchange() method exchanges a given
replacement value at a given position in the array, if a given expected
value equals the old value. It returns the old value at that position
whether it was equal to the expected value or not.
This atomic operation guarantees that no other write happens
until the modified value is written back.
The static Atomics.exchange() method stores 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.
The static Atomics.isLockFree() method is used to determine
whether to use locks or atomic operations. It returns true,
if the given size is one of the BYTES_PER_ELEMENT property
of integer TypedArray types.
The static Atomics.load() method returns a value at a given
position in the array.
The static Atomics.notify() method notifies up some agents that
are sleeping in the wait queue.
Note: This operation works with a shared Int32Array only.
If count is not provided, notifies all the agents in the queue.
Notifies up to count agents in the wait queue.
The static Atomics.or() method computes a bitwise OR with 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.
The static Atomics.store() method stores a given value at the given
position in the array and returns that value.
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.
The static Atomics.wait() method verifies that a given
position in an Int32Array still contains a given value
and if so sleeps, awaiting a wakeup or a timeout.
It returns a string which is either “ok”, “not-equal”, or “timed-out”.
Note: This operation only works with a shared Int32Array
and may not be allowed on the main thread.
Like wait(), but with timeout
The static Atomics.xor() method computes a bitwise XOR
with 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.