javascript instance method
SharedArrayBuffer.prototype.grow()
The grow() method of SharedArrayBuffer instances grows the SharedArrayBuffer to the specified size, in bytes.
Syntax
grow(newLength)
Parameters
newLength- : The new length, in bytes, to resize the
SharedArrayBufferto.
- : The new length, in bytes, to resize the
Return value
None (undefined).
Exceptions
TypeError- : Thrown if the
SharedArrayBufferis not growable.
- : Thrown if the
RangeError- : Thrown if
newLengthis larger than themaxByteLengthof theSharedArrayBufferor smaller than thebyteLength.
- : Thrown if
Description
The grow() method grows a SharedArrayBuffer to the size specified by the newLength parameter, provided that the SharedArrayBuffer is growable and the new size is less than or equal to the maxByteLength of the SharedArrayBuffer. New bytes are initialized to 0.
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 grow()
In this example, we create a 8-byte buffer that is growable to a max length of 16 bytes, then check its growable property, growing it if growable returns true:
const buffer = new SharedArrayBuffer(8, { maxByteLength: 16 });
if (buffer.growable) {
console.log("SAB is growable!");
buffer.grow(12);
}
Specifications
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.