JavaScript | arrayBuffer.byteLength property

Last Updated : 04 Sep, 2019

The arrayBuffer.byteLength is a property in JavaScript which return the length of an ArrayBuffer in byte. ArrayBuffer is an object which is used to represent fixed-length binary data.
Difference between property and function in javascript.
Property in JavaScript is nothing but a value whereas method is a function this can be understood with the help of a example given below.

// car is an object. 
var car = {}; 
  
// car.name is a property of the given object. 
car.name = "Audi", 
  
// car.sayModel is a function of the given object. 
car.sayModel = function() { 
console.log("A8"); 
} 
      
// printing property value. 
console.log(car.name); 
  
// printing function called value. 
console.log(car.sayModel()); 

Output:

> "Audi"
> "A8"

Here as we can see that property of the object car, is going to store the string as “Audi” and it can be accessed with car.name.
sayModel is a method i.e, a function of the object and it can be accessed with car.sayModel().
It can be noticed that sayModel is just a function which uses ().

Difference between bytelength and length property-
Length property returns the length of a String object i.e, number of characters in the string object.
Example:

Input:- geeksforgeeks
Output:- 13

Bytelength property returns the length of an ArrayBuffer in byte. ArrayBuffer is an object which is used to represent fixed-length binary data.
Example:

Input:- ArrayBuffer(2)
Output:- 2

Syntax:

arraybuffer.byteLength

Parameter:

Here nothing as a parameter is being taken because this is a property, not a function.

Return Values:

It returns the length of an ArrayBuffer in byte.

Let’s see JavaScript program on this property:

Code #1:

// ArrayBuffer is created with  
// some size in bytes. 
var A = new ArrayBuffer(2); 
  
// Here the byteLength property  
// is used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer in bytes is printed. 
console.log(B); 

Output:

> 2

Code #2:

// ArrayBuffer is created  
// with some size in bytes. 
var A = new ArrayBuffer(0); 
  
// Here the byteLength property  
// is used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer 
// in bytes is printed. 
console.log(B); 

Output:

> 0

Code #3:

// ArrayBuffer is created 
// with some size in bytes. 
var A = new ArrayBuffer("geeksforgeeks"); 
  
// Here the byteLength property is  
// used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer 
// in bytes is printed. 
console.log(B); 

Output:

> 0

Code #4:

// ArrayBuffer is created  
// with some size in bytes. 
var A = new ArrayBuffer(4.6); 
  
// Here the byteLength property  
// is used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer  
// in bytes is printed. 
console.log(B); 

Output:

> 4

Errors and Exceptions associated with this function:

Negative number can not be taken as the sizes in byte only positive integer value can be taken including zero.

// ArrayBuffer is created  
// with some size in bytes. 
var A = new ArrayBuffer(-2); 
  
// Here the byteLength property is 
// used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer  
// in bytes is printed. 
console.log(B); 

Output:

Error: Invalid array buffer length

Complex number can not be taken as the sizes in byte only positive integer value can be taken including zero.

// ArrayBuffer is created with 
// some size in bytes. 
var A = new ArrayBuffer(2 + 4i); 
  
// Here the byteLength property  
// is used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer 
// in bytes is printed. 
console.log(B); 

Output:

Error: Invalid or unexpected token

The sizes in byte should must be less then $2^5^3$ otherwise it returns Error: Invalid array buffer length.

// ArrayBuffer is created with some size in bytes. 
var A = new ArrayBuffer(2338945720394852703948572); 
  
// Here the byteLength property is 
// used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer in bytes is printed. 
console.log(B); 

Output:

Error: Invalid array buffer length

Application:
Its application is to get the length of an ArrayBuffer in byte.

Code #1:

// ArrayBuffer is created  
// with some size in bytes. 
var A = new ArrayBuffer(23); 
  
// Here the byteLength property  
// is used for checking the size. 
var B = A.byteLength; 
  
// Length of the ArrayBuffer  
// in bytes is printed. 
console.log(B); 

Output:

> 23

My Personal Notes

Related Articles