Class Uint8ArrayList

Implements

Iterable<Uint8Array>

Index

Constructors

constructor

new Uint8ArrayList(...data: Appendable[]): Uint8ArrayList
Parameters
- ...data: Appendable[]
Returns Uint8ArrayList
- Defined in index.ts:136

Properties

`Readonly`[symbol]

"[symbol]": true

length

length: number

Accessors

byteLength

get byteLength(): number
Returns number
- Defined in index.ts:149

Methods

[iterator]

"[iterator]"(): Iterator<Uint8Array<ArrayBufferLike>>
Returns Iterator<Uint8Array<ArrayBufferLike>>
Implementation of Iterable.[iterator]
- Defined in index.ts:145

append

append(...bufs: Appendable[]): void
Add one or more bufs to the end of this Uint8ArrayList
Parameters
- ...bufs: Appendable[]
Returns void
- Defined in index.ts:156

appendAll

appendAll(bufs: Appendable[]): void
Add all bufs to the end of this Uint8ArrayList
Parameters
- bufs: Appendable[]
Returns void
- Defined in index.ts:163

consume

consume(bytes: number): void
Remove bytes from the front of the pool
Parameters
- bytes: number
Returns void
- Defined in index.ts:249

equals

equals(other: any): other is Uint8ArrayList
Parameters
- other: any
Returns other is Uint8ArrayList
- Defined in index.ts:634

get

get(index: number): number
Read the value at index
Parameters
- index: number
Returns number
- Defined in index.ts:214

getBigInt64

getBigInt64(byteOffset: number, littleEndian?: boolean): bigint
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns bigint
- Defined in index.ts:529

getBigUint64

getBigUint64(byteOffset: number, littleEndian?: boolean): bigint
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns bigint
- Defined in index.ts:589

getFloat32

getFloat32(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:604

getFloat64

getFloat64(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:619

getInt16

getInt16(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:499

getInt32

getInt32(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:514

getInt8

getInt8(byteOffset: number): number
Parameters
- byteOffset: number
Returns number
- Defined in index.ts:484

getUint16

getUint16(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:559

getUint32

getUint32(byteOffset: number, littleEndian?: boolean): number
Parameters
- byteOffset: number
- OptionallittleEndian: boolean
Returns number
- Defined in index.ts:574

getUint8

getUint8(byteOffset: number): number
Parameters
- byteOffset: number
Returns number
- Defined in index.ts:544

indexOf

indexOf(
search: Uint8ArrayList | Uint8Array<ArrayBufferLike>,
offset?: number,
): number
Parameters
- search: Uint8ArrayList | Uint8Array<ArrayBufferLike>
- offset: number = 0
Returns number
- Defined in index.ts:411

prepend

prepend(...bufs: Appendable[]): void
Add one or more bufs to the start of this Uint8ArrayList
Parameters
- ...bufs: Appendable[]
Returns void
- Defined in index.ts:186

prependAll

prependAll(bufs: Appendable[]): void
Add all bufs to the start of this Uint8ArrayList
Parameters
- bufs: Appendable[]
Returns void
- Defined in index.ts:193

set

set(index: number, value: number): void
Set the value at index to value
Parameters
- index: number
- value: number
Returns void
- Defined in index.ts:223

setBigInt64

setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: bigint
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:536

setBigUint64

setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: bigint
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:596

setFloat32

setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:611

setFloat64

setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:626

setInt16

setInt16(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:506

setInt32

setInt32(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:521

setInt8

setInt8(byteOffset: number, value: number): void
Parameters
- byteOffset: number
- value: number
Returns void
- Defined in index.ts:491

setUint16

setUint16(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:566

setUint32

setUint32(byteOffset: number, value: number, littleEndian?: boolean): void
Parameters
- byteOffset: number
- value: number
- OptionallittleEndian: boolean
Returns void
- Defined in index.ts:581

setUint8

setUint8(byteOffset: number, value: number): void
Parameters
- byteOffset: number
- value: number
Returns void
- Defined in index.ts:551

slice

slice(beginInclusive?: number, endExclusive?: number): Uint8Array
Extracts a section of an array and returns a new array.

This is a copy operation as it is with Uint8Arrays and Arrays
- note this is different to the behaviour of Node Buffers.
Parameters
- OptionalbeginInclusive: number
- OptionalendExclusive: number
Returns Uint8Array
- Defined in index.ts:284

subarray

subarray(beginInclusive?: number, endExclusive?: number): Uint8Array
Returns a alloc from the given start and end element index.

In the best case where the data extracted comes from a single Uint8Array internally this is a no-copy operation otherwise it is a copy operation.
Parameters
- OptionalbeginInclusive: number
- OptionalendExclusive: number
Returns Uint8Array
- Defined in index.ts:296

sublist

sublist(beginInclusive?: number, endExclusive?: number): Uint8ArrayList
Returns a new Uint8ArrayList from the given start and end element index.

This is a no-copy operation.
Parameters
- OptionalbeginInclusive: number
- OptionalendExclusive: number
Returns Uint8ArrayList
- Defined in index.ts:311

write

write(buf: Appendable, offset?: number): void
Copy bytes from buf to the index specified by offset
Parameters
- buf: Appendable
- offset: number = 0
Returns void
- Defined in index.ts:232

`Static`fromUint8Arrays

fromUint8Arrays(
bufs: Uint8Array<ArrayBufferLike>[],
length?: number,
): Uint8ArrayList
Create a Uint8ArrayList from a pre-existing list of Uint8Arrays. Use this method if you know the total size of all the Uint8Arrays ahead of time.
Parameters
- bufs: Uint8Array<ArrayBufferLike>[]
- Optionallength: number
Returns Uint8ArrayList
- Defined in index.ts:660