API UInt8Array

UInt8Array

Fixed-length packed array of unsigned 8-bit integers.

Script API Reference

Overview

UInt8Array is a primitive-backed array for compact unsigned byte data such as buffers, palettes, and byte-oriented lookup tables. Elements live in contiguous native storage, so the array avoids the per-element object allocation of a general Array.

The length is fixed at construction. push, pop, and element deletion are unavailable; elements are read and written through numeric indexes.

var bytes = new UInt8Array(2);
bytes[0] = 255;
return bytes[0]; // 255

Warning

Indexing outside 0 to length - 1 raises a runtime error. Validate computed indexes before reading or writing.

Use Int8Array when values must be signed, or Array when the element type must vary or the collection has to grow.

Constructors

new UInt8Array([length])

Parameters

Name	Type	Required	Description
length	number	No	Non-negative element count. Omitting it creates an empty array.

Returns

UInt8Array — a fixed-length array whose elements start at 0.

Example

var buffer = new UInt8Array(4);
return buffer[3]; // 0

Properties

values.length

Returns

number — the fixed element count.

Behavior

Read-only. The value never changes for a given instance.

Example

return new UInt8Array(8).length; // 8

Methods

values.fill([value])

Parameters

Name	Type	Required	Description
value	number	No	Value written to every element. Defaults to 0.

Returns

UInt8Array — this array, so calls can be chained.

Behavior

The value is converted to an unsigned 8-bit integer before it is stored, and every element is overwritten in place.

Example

var buffer = new UInt8Array(3);
buffer.fill(7);
return buffer[2]; // 7