Atomics.or()

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.

Syntax

Atomics.or(typedArray, index, value)

Parameters

typedArray

A shared integer typed array. One of Int8Array, Uint8Array, Int16Array, Uint16Array, Int32Array, or Uint32Array.

index

The position in the typedArray to compute the bitwise OR.

value

The number to compute the bitwise OR with.

Return value

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

Exceptions

• Throws a TypeError, if typedArray is not one of the allowed integer types.
• Throws a TypeError, if typedArray is not a shared typed array type.
• Throws a RangeError, if index is out of bounds in the typedArray.

Description

The bitwise OR operation yields 1, if either a or b are 1. The truth table for the OR operation is:

For example, a bitwise OR of 5 & 1 results in 0101 which is 5 in decimal.

5  0101
1  0001
   ----
5  0101

Examples

var sab = new SharedArrayBuffer(1024);
var ta = new Uint8Array(sab);
ta[0] = 2;
Atomics.or(ta, 0, 1); // returns 2, the old value
Atomics.load(ta, 0);  // 3

Specifications

Browser compatibility

[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

See also

• Atomics
• Atomics.and()
• Atomics.xor()