TypedArray.prototype.byteLength

Baseline 広く利用可能

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。

byteLength は TypedArray のアクセサープロパティで、この型付き配列の長さを（バイト単位で）返します。

試してみましょう

// ArrayBuffer をバイト単位のサイズで作成
const buffer = new ArrayBuffer(8);
const uint8 = new Uint8Array(buffer, 2);

console.log(uint8.byteLength);
// 予想される結果: 6

byteLength プロパティはアクセサープロパティであり、その設定アクセサー関数は undefined です。つまり、このプロパティは読み取り専用です。型付き配列が長さ追跡である場合、その長さは基盤となるバッファーの長さに依存し、バッファのサイズ変更時に変更されることがあります。そうでない場合、値は型付き配列の構築時に確定され、変更できません。長さ追跡の有無にかかわらず、基盤となるバッファーのサイズ変更により表示範囲ができなくなった場合、byteLength は 0 になります。

例

byteLength プロパティの使用

js
const buffer = new ArrayBuffer(8);

const uint8 = new Uint8Array(buffer);
uint8.byteLength; // 8 （バッファーのバイト長と一致する）

const uint8newLength = new Uint8Array(buffer, 1, 5);
uint8newLength.byteLength; // 5 （Uint8Array の構築時に指定したとおり）

const uint8offset = new Uint8Array(buffer, 2);
uint8offset.byteLength; // 6 （構築された Uint8Array のオフセットによる）

const buffer2 = new ArrayBuffer(16, { maxByteLength: 32 });
const uint8lengthTracking = new Uint8Array(buffer2, 4);
uint8lengthTracking.byteLength; // 12 (16 - 4)
buffer2.resize(20);
uint8lengthTracking.byteLength; // 16 (20 - 4)
buffer2.resize(3);
uint8lengthTracking.byteLength; // 0 （ビュー範囲が有効ではなくなった）