ArrayType<TType> Interface

Package: @esfx/struct-type

Represents the constructor for a TypedArray

Declaration

export interface ArrayType<TType extends Type> 

Properties

[InitType]

Declaration

[InitType]: TypedArray<TType, number> | ArrayLike<InitType<TType>>;

Property Value

TypedArray<TType, number> | ArrayLike<InitType<TType>>

[RuntimeType]

Declaration

[RuntimeType]: TypedArray<TType, number>;

Property Value

TypedArray<TType, number>

BYTES_PER_ELEMENT

The number of bytes per each element of the array.

Declaration

readonly BYTES_PER_ELEMENT: number;

Property Value

number

fixedLength

Declaration

readonly fixedLength: number | undefined;

Property Value

number | undefined

prototype

Declaration

prototype: TypedArray<TType>;

Property Value

TypedArray<TType>

SIZE

Declaration

readonly SIZE: number | undefined;

Property Value

number | undefined

Methods

read(buffer, byteOffset, shared, byteOrder)

Reads an array of values value from the buffer. The resulting array value will be backed by its own buffer.

Declaration

read(buffer: ArrayBufferLike, byteOffset: number, shared?: boolean, byteOrder?: Endianness): TypedArray<TType>;

Parameters

buffer

ArrayBufferLike

The ArrayBuffer or SharedArrayBuffer from which to read the array.

byteOffset

number

The byte offset into <xref:buffer> at which to start reading.

shared

boolean

When true, the resulting value will be backed by a SharedArrayBuffer.

byteOrder

Endianness

The endianness to use when reading the array. If unspecified, the native byte order will be used.

Returns

TypedArray<TType>

read(buffer, byteOffset, length, shared, byteOrder)

Reads an array of values value from the buffer. The resulting array value will be backed by its own buffer.

Declaration

read(buffer: ArrayBufferLike, byteOffset: number, length?: number, shared?: boolean, byteOrder?: Endianness): TypedArray<TType>;

Parameters

buffer

ArrayBufferLike

The ArrayBuffer or SharedArrayBuffer from which to read the array.

byteOffset

number

The byte offset into <xref:buffer> at which to start reading.

length

number

The number of array elements to read from the buffer.

shared

boolean

When true, the resulting value will be backed by a SharedArrayBuffer.

byteOrder

Endianness

The endianness to use when reading the array. If unspecified, the native byte order will be used.

Returns

TypedArray<TType>

toFixed(fixedLength)

Gets a fixed-length subtype for this array type.

Declaration

toFixed<TFixedLength extends number>(fixedLength: TFixedLength): FixedLengthArrayType<TType, TFixedLength>;

Type Parameters

TFixedLength

Parameters

fixedLength

TFixedLength

Returns

FixedLengthArrayType<TType, TFixedLength>

write(buffer, byteOffset, value, byteOrder)

Writes an array of values to a buffer.

Declaration

write(buffer: ArrayBufferLike, byteOffset: number, value: TypedArray<TType>, byteOrder?: Endianness): void;

Parameters

buffer

ArrayBufferLike

The ArrayBuffer or SharedArrayBuffer into which to write the array.

byteOffset

number

The byte offset into <xref:buffer> at which to start writing.

value

TypedArray<TType>

The array to write.

byteOrder

Endianness

The endianness to use when writing the array. If unspecified, the native byte order will be used.

Returns

void