Class Uint8ArrayList<T>

constructor

• new Uint8ArrayList<T extends ArrayBufferLike = ArrayBufferLike>(
      ...data: Appendable<T>[],
  ): Uint8ArrayList<T>

  Type Parameters

  • T extends ArrayBufferLike = ArrayBufferLike

  Parameters

  • ...data: Appendable<T>[]

  Returns Uint8ArrayList<T>

Readonly[symbol]

length

byteLength

• get byteLength(): number

  Returns number

[iterator]

• "[iterator]"(): Iterator<Uint8Array<T>>

  Returns Iterator<Uint8Array<T>>

append

• append(...bufs: Appendable<T>[]): void

  Add one or more bufs to the end of this Uint8ArrayList

  Parameters

  • ...bufs: Appendable<T>[]

  Returns void

appendAll

• appendAll(bufs: Appendable<T>[]): void

  Add all bufs to the end of this Uint8ArrayList

  Parameters

  • bufs: Appendable<T>[]

  Returns void

consume

• consume(bytes: number): void

  Remove bytes from the front of the pool

  Parameters

  • bytes: number

  Returns void

equals

• equals(other: any): other is Uint8ArrayList<ArrayBufferLike>

  Parameters

  • other: any

  Returns other is Uint8ArrayList<ArrayBufferLike>

get

• get(index: number): number

  Read the value at index

  Parameters

  • index: number

  Returns number

getBigInt64

• getBigInt64(byteOffset: number, littleEndian?: boolean): bigint

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns bigint

getBigUint64

• getBigUint64(byteOffset: number, littleEndian?: boolean): bigint

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns bigint

getFloat32

• getFloat32(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getFloat64

• getFloat64(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getInt16

• getInt16(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getInt32

• getInt32(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getInt8

• getInt8(byteOffset: number): number

  Parameters

  • byteOffset: number

  Returns number

getUint16

• getUint16(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getUint32

• getUint32(byteOffset: number, littleEndian?: boolean): number

  Parameters

  • byteOffset: number
  • OptionallittleEndian: boolean

  Returns number

getUint8

• getUint8(byteOffset: number): number

  Parameters

  • byteOffset: number

  Returns number

indexOf

• indexOf(
      search: Uint8Array<ArrayBufferLike> | Uint8ArrayList<ArrayBufferLike>,
      offset?: number,
  ): number

  Parameters

  • search: Uint8Array<ArrayBufferLike> | Uint8ArrayList<ArrayBufferLike>
  • offset: number = 0

  Returns number

prepend

• prepend(...bufs: Appendable<T>[]): void

  Add one or more bufs to the start of this Uint8ArrayList

  Parameters

  • ...bufs: Appendable<T>[]

  Returns void

prependAll

• prependAll(bufs: Appendable<T>[]): void

  Add all bufs to the start of this Uint8ArrayList

  Parameters

  • bufs: Appendable<T>[]

  Returns void

set

• set(index: number, value: number): void

  Set the value at index to value

  Parameters

  • index: number
  • value: number

  Returns void

setBigInt64

• setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: bigint
  • OptionallittleEndian: boolean

  Returns void

setBigUint64

• setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: bigint
  • OptionallittleEndian: boolean

  Returns void

setFloat32

• setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setFloat64

• setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setInt16

• setInt16(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setInt32

• setInt32(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setInt8

• setInt8(byteOffset: number, value: number): void

  Parameters

  • byteOffset: number
  • value: number

  Returns void

setUint16

• setUint16(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setUint32

• setUint32(byteOffset: number, value: number, littleEndian?: boolean): void

  Parameters

  • byteOffset: number
  • value: number
  • OptionallittleEndian: boolean

  Returns void

setUint8

• setUint8(byteOffset: number, value: number): void

  Parameters

  • byteOffset: number
  • value: number

  Returns void

slice

• slice(beginInclusive?: number, endExclusive?: number): Uint8Array<ArrayBuffer>

  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<ArrayBuffer>

subarray

• subarray(
      beginInclusive?: number,
      endExclusive?: number,
  ): Uint8Array<ArrayBuffer | T>

  Returns a section of the array from the given start and end element index.

  This is a no-copy operation where the data extracted data comes from a single Uint8Array internally, otherwise it is a copy operation.

  Parameters

  • OptionalbeginInclusive: number
  • OptionalendExclusive: number

  Returns Uint8Array<ArrayBuffer | T>

sublist

• sublist(beginInclusive?: number, endExclusive?: number): Uint8ArrayList<T>

  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<T>

write

• write(buf: Appendable<ArrayBuffer | T>, offset?: number): void

  Copy bytes from buf to the index specified by offset

  Parameters

  • buf: Appendable<ArrayBuffer | T>
  • offset: number = 0

  Returns void

StaticfromUint8Arrays

• fromUint8Arrays<T extends ArrayBufferLike>(
      bufs: Uint8Array<T>[],
      length?: number,
  ): Uint8ArrayList<T>

  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.

  Type Parameters

  • T extends ArrayBufferLike

  Parameters

  • bufs: Uint8Array<T>[]
  • Optionallength: number

  Returns Uint8ArrayList<T>