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.
Return value
None (undefined).
Exceptions
TypeError-
Thrown if the
SharedArrayBufferis not growable. RangeError-
Thrown if
newLengthis larger than themaxByteLengthof theSharedArrayBufferor smaller than thebyteLength.
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
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
| Specification |
|---|
| ECMAScript Language Specification # sec-sharedarraybuffer.prototype.grow |
Browser compatibility
| desktop | mobile | server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
grow | |||||||||||||