JavaScript maxByteLength in ArrayBuffer is used to set the maximum size of ArrayBuffer in bytes. This specified length is the maximum length to which we can resize the ArrayBuffer. This is a read-only property and can only be set when the ArrayBuffer object is created and cannot be changed afterward. If this property is left blank it is by default set to the byteLength specified during object creation.
Syntax:
{maxByteLength: val} // To set max value
arr.maxByteLength // To get max value
Parameter: It has one parameter only
Return Value: When used as a getter it returns the maximum value in Number.
Example 1: This example will set the maximum value and print it on the console.
Javascript
let arr = new ArrayBuffer(8, { maxByteLength: 24 });console.log(arr.maxByteLength);arr.resize(28); |
Output: When we try to resize the array beyond it’s maximum capacity it will throw an error.
Example 2: This example will try to increase the byteLength beyond it’s capacity.
HTML
<!DOCTYPE html><html lang="en"><head></head><body style="text-align:center;"> <h1 style="color:green"> neveropen </h1> <p> Size of ArrayBuffer: </p> <p id="gfg"></p> <button onclick="increase()"> Click here to increase size </button> <script> let arr1 = new ArrayBuffer(22, { maxByteLength: 24 }); document.getElementById("gfg") .innerHTML = arr1.byteLength; function increase() { console.log("hello"); if (arr1.byteLength == arr1.maxByteLength) { document.getElementById("gfg") .innerHTML = "Maximum capacity reached"; } else { arr1.resize(arr1.byteLength + 1); document.getElementById("gfg") .innerHTML = arr1.byteLength; } } </script></body></html> |
Output:
JavaScript ArrayBuffer.maxByteLength property
Supported Browsers:
- Chrome
- Edge
- Safari
We have a complete list of ArrayBuffer methods and properties, to check Please go through the JavaScript ArrayBuffer Reference article.