struct-view

struct-view / Exports / StructType

Interface: StructType<T>

Type parameters

Name
T

Hierarchy

• StructConstructor<T>

• Decorator<T>

• ReadonlyPropertyFactory<Struct<T>>

• ReadonlyArrayPropertyFactory<readonly Struct<T>[]>

  ↳ StructType

Callable

▸ StructType<U>(Base: StructConstructor<U>, byteOffset: number): StructConstructor<T & U>

Type parameters:

Name
U

Parameters:

Name	Type
Base	StructConstructor<U>
byteOffset	number

Returns: StructConstructor<T & U>

Defined in: decorator.ts:3

▸ StructType<K>(name: K): Decorator<Readonly<Record<K, Struct<T>>>>

Type parameters:

Name	Type
K	string

Parameters:

Name	Type
name	K

Returns: Decorator<Readonly<Record<K, Struct<T>>>>

Defined in: factories.ts:11

▸ StructType(length: number): ReadonlyPropertyFactory<readonly Struct<T>[]>

Parameters:

Name	Type
length	number

Returns: ReadonlyPropertyFactory<readonly Struct<T>[]>

Defined in: factories.ts:15

Table of contents

Constructors

• constructor

Properties

• BYTES_PER_INSTANCE
• prototype

Methods

• from

Constructors

constructor

+ new StructType(buffer?: ArrayBufferLike, byteOffset?: number, byteLength?: number): Struct<T>

Parameters:

Name	Type
buffer?	ArrayBufferLike
byteOffset?	number
byteLength?	number

Returns: Struct<T>

Inherited from: StructConstructor

Defined in: struct.ts:7

Properties

BYTES_PER_INSTANCE

• Readonly BYTES_PER_INSTANCE: number

Inherited from: StructConstructor.BYTES_PER_INSTANCE

Defined in: struct.ts:13

---

prototype

• Readonly prototype: Struct<T>

Inherited from: StructConstructor.prototype

Defined in: struct.ts:7

Methods

from

▸ from(array: ArrayBufferView, byteOffset?: number, byteLength?: number): Struct<T>

Parameters:

Name	Type
array	ArrayBufferView
byteOffset?	number
byteLength?	number

Returns: Struct<T>

Inherited from: StructConstructor

Defined in: struct.ts:11

This site is open source. Improve this page.