The ArrayBuffer
object is used to represent a generic raw binary data buffer.
It is an array of bytes, often referred to in other languages as a "byte array". You cannot directly manipulate the contents of an ArrayBuffer
; instead, you create one of the typed array objects or a DataView
object which represents the buffer in a specific format, and use that to read and write the contents of the buffer.
The ArrayBuffer()
constructor creates a new ArrayBuffer
of the given length in bytes. You can also get an array buffer from existing data, for example, from a Base64 string or from a local file.
ArrayBuffer
is a transferable object.
Resizing ArrayBuffers
ArrayBuffer
objects can be made resizable by including the maxByteLength
option when calling the ArrayBuffer()
constructor. You can query whether an ArrayBuffer
is resizable and what its maximum size is by accessing its resizable
and maxByteLength
properties, respectively. You can assign a new size to a resizable ArrayBuffer
with a resize()
call. New bytes are initialized to 0.
These features make resizing ArrayBuffer
s more efficient — otherwise, you have to make a copy of the buffer with a new size. It also gives JavaScript parity with WebAssembly in this regard (Wasm linear memory can be resized with WebAssembly.Memory.prototype.grow()
).
Transferring ArrayBuffers
ArrayBuffer
objects can be transferred between different execution contexts, like Web Workers or Service Workers, using the structured clone algorithm. This is done by passing the ArrayBuffer
as a transferable object in a call to Worker.postMessage()
or ServiceWorker.postMessage()
. In pure JavaScript, you can also transfer the ownership of memory from one ArrayBuffer
to another using its transfer()
or transferToFixedLength()
method.
When an ArrayBuffer
is transferred, its original copy becomes detached — this means it is no longer usable. At any moment, there will only be one copy of the ArrayBuffer
that actually has access to the underlying memory. Detached buffers have the following behaviors:
byteLength
becomes 0 (in both the buffer and the associated typed array views).
- Methods, such as
resize()
and slice()
, throw a TypeError
when invoked. The associated typed array views' methods also throw a TypeError
.
You can check whether an ArrayBuffer
is detached by its detached
property.
Creating an ArrayBuffer
In this example, we create a 8-byte buffer with a Int32Array
view referring to the buffer:
const buffer = new ArrayBuffer(8);
const view = new Int32Array(buffer);
Specifications
Browser compatibility
|
Desktop |
Mobile |
Server |
|
Chrome |
Edge |
Firefox |
Opera |
Safari |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
WebView Android |
Deno |
Node.js |
@@species |
51 |
13 |
48 |
38 |
10 |
51 |
48 |
41 |
10 |
5.0 |
51 |
1.0 |
6.5.0 |
ArrayBuffer |
7 |
12 |
4 |
11.6 |
5.1 |
18 |
4 |
12 |
4.2 |
1.0 |
4 |
1.0 |
0.10.0 |
ArrayBuffer |
7 |
12 |
4 |
11.6 |
5.1 |
18 |
4 |
12 |
4.2 |
1.0 |
4 |
1.0 |
0.10.0 |
byteLength |
7 |
12 |
4 |
11.6 |
5.1 |
18 |
4 |
12 |
4.2 |
1.0 |
4 |
1.0 |
0.10.0 |
detached |
114 |
114 |
122 |
100 |
preview |
114 |
122 |
76 |
No |
23.0 |
114 |
No |
No |
isView |
32 |
12 |
29 |
19 |
7 |
32 |
29 |
19 |
7 |
2.0 |
4.4.3 |
1.0 |
4.0.0 |
maxByteLength |
111 |
111 |
No |
97 |
16.4 |
111 |
No |
75 |
16.4 |
22.0 |
111 |
1.33 |
20.0.0 |
resizable |
111 |
111 |
No |
97 |
16.4 |
111 |
No |
75 |
16.4 |
22.0 |
111 |
1.33 |
20.0.0 |
resize |
111 |
111 |
No |
97 |
16.4 |
111 |
No |
75 |
16.4 |
22.0 |
111 |
1.33 |
20.0.0 |
slice |
17 |
12 |
12The non-standard ArrayBuffer.slice() method has been removed in Firefox 53 (but the standardized version ArrayBuffer.prototype.slice() is kept.
|
12.1 |
5.1 |
18 |
14The non-standard ArrayBuffer.slice() method has been removed in Firefox 53 (but the standardized version ArrayBuffer.prototype.slice() is kept.
|
12.1 |
6 |
1.0 |
4.4 |
1.0 |
0.12.0 |
transfer |
114 |
114 |
122 |
100 |
preview |
114 |
122 |
76 |
No |
23.0 |
114 |
No |
No |
transferToFixedLength |
114 |
114 |
122 |
100 |
preview |
114 |
122 |
76 |
No |
23.0 |
114 |
No |
No |