UnorderedMap

collections/unordered-map • Docs

---

near-sdk-js v2.0.0 / collections/unordered-map / UnorderedMap

Class: UnorderedMap<DataType>

An unordered map that stores data in NEAR storage.

Extends

• SubType<DataType>

Type Parameters

• DataType

Constructors

new UnorderedMap()

new UnorderedMap<DataType>(prefix): UnorderedMap<DataType>

Parameters

• prefix: string

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

Returns

UnorderedMap<DataType>

Overrides

SubType.constructor

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:27

Properties

_keys

readonly _keys: Vector<string>

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:21

---

prefix

readonly prefix: string

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

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:27

---

values

readonly values: LookupMap<ValueAndIndex>

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:22

Accessors

length

get length(): number

The number of elements stored in the collection.

Returns

number

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:36

Methods

[iterator]()

[iterator](): UnorderedMapIterator<DataType>

Returns

UnorderedMapIterator<DataType>

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:145

---

clear()

clear(): void

Remove all of the elements stored within the collection.

Returns

void

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:136

---

extend()

extend(keyValuePairs): void

Extends the current collection with the passed in array of key-value pairs.

Parameters

• keyValuePairs: [string, DataType][]

The key-value pairs to extend the collection with.

Returns

void

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:184

---

get()

get(key, options?): DataType

Get the data stored at the provided key.

Parameters

• key: string

The key at which to look for the data.

• options?: Omit<GetOptions<DataType>, "serializer">

Options for retrieving the data.

Returns

DataType

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:53

---

isEmpty()

isEmpty(): boolean

Checks whether the collection is empty.

Returns

boolean

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:43

---

keys()

keys(__namedParameters): string[]

Parameters

• __namedParameters

• __namedParameters.limit: any

• __namedParameters.start: any

Returns

string[]

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:220

---

remove()

remove(key, options?): DataType

Removes and retrieves the element with the provided key.

Parameters

• key: string

The key at which to remove data.

• options?: Omit<GetOptions<DataType>, "serializer">

Options for retrieving the data.

Returns

DataType

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:105

---

serialize()

serialize(options?): Uint8Array

Serialize the collection.

Parameters

• options?: Pick<GetOptions<DataType>, "serializer">

Options for storing the data.

Returns

Uint8Array

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:195

---

set()

set(key, value, options?): DataType

Store a new value at the provided key.

Parameters

• key: string

The key at which to store in the collection.

• value: DataType

The value to store in the collection.

• options?: GetOptions<DataType>

Options for retrieving and storing the data.

Returns

DataType

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:76

---

set_reconstructor()

set_reconstructor(options?): Omit<GetOptions<DataType>, "serializer">

Parameters

• 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

---

toArray()

toArray(options?): [string, DataType][]

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

Parameters

• options?: GetOptions<DataType>

Options for retrieving and storing the data.

Returns

[string, DataType][]

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:167

---

reconstruct()

static reconstruct<DataType>(data): UnorderedMap<DataType>

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

Type Parameters

• DataType

Parameters

• data: UnorderedMap<DataType>

The deserialized data to create an instance from.

Returns

UnorderedMap<DataType>

Defined in

packages/near-sdk-js/src/collections/unordered-map.ts:204