SharedArrayBuffer.prototype.maxByteLength

The maxByteLength accessor property of {{jsxref("SharedArrayBuffer")}} instances returns the maximum length (in bytes) that this SharedArrayBuffer can be grown to.

Description#

The maxByteLength property is an accessor property whose set accessor function is undefined, meaning that you can only read this property. The value is established when the shared array is constructed, set via the maxByteLength option of the {{jsxref("SharedArrayBuffer/SharedArrayBuffer", "SharedArrayBuffer()")}} constructor, and cannot be changed.

If this SharedArrayBuffer was constructed without specifying a maxByteLength value, this property returns a value equal to the value of the SharedArrayBuffer's {{jsxref("SharedArrayBuffer/byteLength", "byteLength")}}.

Examples#

Note that these examples cannot be run directly from the console or an arbitrary web page, because SharedArrayBuffer is not defined unless its security requirements are met.

Using maxByteLength#

In this example, we create a 8-byte buffer that is resizable to a max length of 16 bytes, then return its maxByteLength:

const buffer = new SharedArrayBuffer(8, { maxByteLength: 16 });

buffer.maxByteLength; // 16

Specifications#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

• {{jsxref("SharedArrayBuffer")}}