Class Vector<DataType>

constructor

• new Vector<DataType>(prefix, length?): Vector<DataType>

• Type Parameters

  • DataType

  Parameters

  • prefix: string

    The byte prefix to use when storing elements inside this collection.
  • length: number = 0

    The initial length of the collection. By default 0.

  Returns Vector<DataType>

length

Readonlyprefix

[iterator]

• [iterator](): VectorIterator<DataType>

• Returns VectorIterator<DataType>

clear

• clear(): void

• Remove all of the elements stored within the collection.

  Returns void

extend

• extend(elements): void

• Extends the current collection with the passed in array of elements.

  Parameters

  • elements: DataType[]

    The elements to extend the collection with.

  Returns void

get

• get(index, options?): DataType

• Get the data stored at the provided index.

  Parameters

  • index: number

    The index at which to look for the data.
  • Optionaloptions: Omit<GetOptions<DataType>, "serializer">

    Options for retrieving the data.

  Returns DataType

isEmpty

• isEmpty(): boolean

• Checks whether the collection is empty.

  Returns boolean

pop

• pop(options?): DataType

• Removes and retrieves the element with the highest index.

  Parameters

  • Optionaloptions: Omit<GetOptions<DataType>, "serializer">

    Options for retrieving the data.

  Returns DataType

push

• push(element, options?): void

• Adds data to the collection.

  Parameters

  • element: DataType

    The data to store.
  • Optionaloptions: Pick<GetOptions<DataType>, "serializer">

    Options for storing the data.

  Returns void

replace

• replace(index, element, options?): DataType

• Replaces the data stored at the provided index with the provided data and returns the previously stored data.

  Parameters

  • index: number

    The index at which to replace the data.
  • element: DataType

    The data to replace with.
  • Optionaloptions: GetOptions<DataType>

    Options for retrieving and storing the data.

  Returns DataType

serialize

• serialize(options?): Uint8Array

• Serialize the collection.

  Parameters

  • Optionaloptions: Pick<GetOptions<DataType>, "serializer">

    Options for storing the data.

  Returns Uint8Array

swapRemove

• swapRemove(index, options?): DataType

• Removes an element from the vector and returns it in serialized form. The removed element is replaced by the last element of the vector. Does not preserve ordering, but is O(1).

  Parameters

  • index: number

    The index at which to remove the element.
  • Optionaloptions: GetOptions<DataType>

    Options for retrieving and storing the data.

  Returns DataType

toArray

• toArray(options?): DataType[]

• Return a JavaScript array of the data stored within the collection.

  Parameters

  • Optionaloptions: GetOptions<DataType>

    Options for retrieving and storing the data.

  Returns DataType[]

Staticreconstruct

• reconstruct<DataType>(data): Vector<DataType>

• Converts the deserialized data from storage to a JavaScript instance of the collection.

  Type Parameters

  • DataType

  Parameters

  • data: Vector<DataType>

    The deserialized data to create an instance from.

  Returns Vector<DataType>