Class Vector<DataType>

An iterable implementation of vector that stores its content on the trie. Uses the following map: index -> element

Type Parameters

DataType

Hierarchy

SubType<DataType>
- Vector

Index

Constructors

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>
Overrides SubType.constructor
- Defined in packages/near-sdk-js/src/collections/vector.ts:31

Properties

length

length: number = 0

The initial length of the collection. By default 0.

`Readonly` prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

Methods

[iterator]

[iterator](): VectorIterator<DataType>
Returns VectorIterator<DataType>
- Defined in packages/near-sdk-js/src/collections/vector.ts:174

clear

clear(): void
Remove all of the elements stored within the collection.

Returns void
- Defined in packages/near-sdk-js/src/collections/vector.ts:211

`Private` createIteratorWithOptions

createIteratorWithOptions(options?): {
[iterator](): VectorIterator<DataType>;
}
Create a iterator on top of the default collection iterator using custom options.
Parameters
- Optional options: GetOptions<DataType>
  Options for retrieving and storing the data.
Returns {
[iterator](): VectorIterator<DataType>;
}
- [iterator]:function
  - [iterator](): VectorIterator<DataType>
  - Returns VectorIterator<DataType>
    - Defined in packages/near-sdk-js/src/collections/vector.ts:184
- Defined in packages/near-sdk-js/src/collections/vector.ts:183

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
- Defined in packages/near-sdk-js/src/collections/vector.ts:168

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.
- Optional options: Omit<GetOptions<DataType>, "serializer">
  Options for retrieving the data.
Returns DataType
- Defined in packages/near-sdk-js/src/collections/vector.ts:48

isEmpty

isEmpty(): boolean
Checks whether the collection is empty.

Returns boolean
- Defined in packages/near-sdk-js/src/collections/vector.ts:38

pop

pop(options?): DataType
Removes and retrieves the element with the highest index.
Parameters
- Optional options: Omit<GetOptions<DataType>, "serializer">
  Options for retrieving the data.
Returns DataType
- Defined in packages/near-sdk-js/src/collections/vector.ts:118

push

push(element, options?): void
Adds data to the collection.
Parameters
- element: DataType
  The data to store.
- Optional options: Pick<GetOptions<DataType>, "serializer">
  Options for storing the data.
Returns void
- Defined in packages/near-sdk-js/src/collections/vector.ts:100

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.
- Optional options: GetOptions<DataType>
  Options for retrieving and storing the data.
Returns DataType
- Defined in packages/near-sdk-js/src/collections/vector.ts:141

serialize

serialize(options?): Uint8Array
Serialize the collection.
Parameters
- Optional options: Pick<GetOptions<DataType>, "serializer">
  Options for storing the data.
Returns Uint8Array
- Defined in packages/near-sdk-js/src/collections/vector.ts:225

set_reconstructor

set_reconstructor(options?): Omit<GetOptions<DataType>, "serializer">
Parameters
- Optional options: Omit<GetOptions<DataType>, "serializer">
Returns Omit<GetOptions<DataType>, "serializer">
Inherited from SubType.set_reconstructor
- Defined in packages/near-sdk-js/src/collections/subtype.ts:8

subtype

subtype(): any
Returns any
Inherited from SubType.subtype
- Defined in packages/near-sdk-js/src/collections/subtype.ts:6

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.
- Optional options: GetOptions<DataType>
  Options for retrieving and storing the data.
Returns DataType
- Defined in packages/near-sdk-js/src/collections/vector.ts:70

toArray

toArray(options?): DataType[]
Return a JavaScript array of the data stored within the collection.
Parameters
- Optional options: GetOptions<DataType>
  Options for retrieving and storing the data.
Returns DataType[]
- Defined in packages/near-sdk-js/src/collections/vector.ts:196

`Static` reconstruct

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>
- Defined in packages/near-sdk-js/src/collections/vector.ts:234

Class Vector<DataType>

Type Parameters

DataType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

DataType

Parameters

prefix: string

length: number = 0

Returns Vector<DataType>

Properties

length

Readonly prefix

Methods

[iterator]

Returns VectorIterator<DataType>

clear

Returns void

Private createIteratorWithOptions

Parameters

Optional options: GetOptions<DataType>

Returns { [iterator](): VectorIterator<DataType>; }

[iterator]:function

Returns VectorIterator<DataType>

extend

Parameters

elements: DataType[]

Returns void

get

Parameters

index: number

Optional options: Omit<GetOptions<DataType>, "serializer">

Returns DataType

isEmpty

Returns boolean

pop

Parameters

Optional options: Omit<GetOptions<DataType>, "serializer">

Returns DataType

push

Parameters

element: DataType

Optional options: Pick<GetOptions<DataType>, "serializer">

Returns void

replace

Parameters

index: number

element: DataType

Optional options: GetOptions<DataType>

Returns DataType

serialize

Parameters

Optional options: Pick<GetOptions<DataType>, "serializer">

Returns Uint8Array

set_reconstructor

Parameters

Optional options: Omit<GetOptions<DataType>, "serializer">

Returns Omit<GetOptions<DataType>, "serializer">

subtype

Returns any

swapRemove

Parameters

index: number

Optional options: GetOptions<DataType>

Returns DataType

toArray

Parameters

Optional options: GetOptions<DataType>

Returns DataType[]

Static reconstruct

Type Parameters

DataType

Parameters

data: Vector<DataType>

`Readonly` prefix

`Private` createIteratorWithOptions

`Optional` options: GetOptions<DataType>

Returns {
[iterator](): VectorIterator<DataType>;
}

`Optional` options: Omit<GetOptions<DataType>, "serializer">

`Optional` options: Omit<GetOptions<DataType>, "serializer">

`Optional` options: Pick<GetOptions<DataType>, "serializer">

`Optional` options: GetOptions<DataType>

`Optional` options: Pick<GetOptions<DataType>, "serializer">

`Optional` options: Omit<GetOptions<DataType>, "serializer">

`Optional` options: GetOptions<DataType>

`Optional` options: GetOptions<DataType>

`Static` reconstruct