files/en-us/web/javascript/reference/global_objects/atomics/waitasync/index.md

metadata

title: Atomics.waitAsync()
short-title: waitAsync()
slug: Web/JavaScript/Reference/Global_Objects/Atomics/waitAsync
page-type: javascript-static-method
browser-compat: javascript.builtins.Atomics.waitAsync
sidebar: jsref

The Atomics.waitAsync() static method verifies that a shared memory location contains a given value, immediately returning an object with the value property containing the string "not-equal" if the memory location does not match the given value, or "timed-out" if the timeout was set to zero. Otherwise the method returns an object where the value property is a {{jsxref("Promise")}} that fulfills with either "ok" when {{jsxref("Atomics.notify()")}} is called, or "timed-out" if the timeout expires.

Atomics.waitAsync() and {{jsxref("Atomics.notify()")}} are used together to enable thread synchronization based on a value in shared memory. A thread can proceed immediately if the synchronization value has changed, or it can wait for notification from another thread when it reaches the synchronization point.

This method only works with an {{jsxref("Int32Array")}} or {{jsxref("BigInt64Array")}} that views a {{jsxref("SharedArrayBuffer")}}. It is non-blocking and, unlike {{jsxref("Atomics.wait()")}}, can be used on the main thread. Because it does not block the whole thread, you still need to be careful not to access the shared memory before the promise settles.

Syntax

Atomics.waitAsync(typedArray, index, value)
Atomics.waitAsync(typedArray, index, value, timeout)

Parameters

• typedArray
  • : An {{jsxref("Int32Array")}} or {{jsxref("BigInt64Array")}} that views a {{jsxref("SharedArrayBuffer")}}.
• index
  • : The position in the typedArray to wait on.
• value
  • : The expected value to test.
• timeout {{optional_inline}}
  • : Time to wait in milliseconds. {{jsxref("NaN")}} (and values that get converted to NaN, such as undefined) becomes {{jsxref("Infinity")}}. Negative values become 0.

Return value

An {{jsxref("Object")}} with the following properties:

• async
  • : A boolean indicating whether the value property is a {{jsxref("Promise")}} or not.
• value
  • : If async is false, it will be a string which is either "not-equal" or "timed-out" (only when the timeout parameter is 0). If async is true, it will be a {{jsxref("Promise")}} which is fulfilled with a string value, either "ok" or "timed-out". The promise is never rejected.

Exceptions

• {{jsxref("TypeError")}}
  • : Thrown if typedArray is not an {{jsxref("Int32Array")}} or {{jsxref("BigInt64Array")}} that views a {{jsxref("SharedArrayBuffer")}}.
• {{jsxref("RangeError")}}
  • : Thrown if index is out of bounds in the typedArray.

Examples

Using waitAsync()

Given a shared Int32Array.

const sab = new SharedArrayBuffer(1024);
const int32 = new Int32Array(sab);

A reading thread is sleeping and waiting on location 0 which is expected to be 0. The result.value will be a promise.

const result = Atomics.waitAsync(int32, 0, 0, 1000);
// { async: true, value: Promise {<pending>} }

In the reading thread or in another thread, the memory location 0 is called and the promise can be resolved with "ok".

Atomics.notify(int32, 0);
// { async: true, value: Promise {<fulfilled>: 'ok'} }

If it isn't resolving to "ok", the value in the shared memory location wasn't the expected (the value would be "not-equal" instead of a promise) or the timeout was reached (the promise will resolve to "time-out").

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{jsxref("Atomics")}}
• {{jsxref("Atomics.wait()")}}
• {{jsxref("Atomics.notify()")}}