LookupMap
Last updated
Last updated
collections/lookup-map • Docs
near-sdk-js v2.0.0 / collections/lookup-map / LookupMap
A lookup map that stores data in NEAR storage.
SubType<DataType>
• DataType
new LookupMap<
DataType>(keyPrefix):LookupMap<DataType>
Parameters
• keyPrefix: string
The byte prefix to use when storing elements inside this collection.
Returns
LookupMap<DataType>
Overrides
Defined in
packages/near-sdk-js/src/collections/lookup-map.ts:17
readonlykeyPrefix:string
The byte prefix to use when storing elements inside this collection.
Defined in
packages/near-sdk-js/src/collections/lookup-map.ts:17
containsKey(
key):boolean
Checks whether the collection contains the value.
Parameters
• key: string
The value for which to check the presence.
Returns
boolean
Defined in
packages/near-sdk-js/src/collections/lookup-map.ts:26
extend(
keyValuePairs,options?):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.
• options?: GetOptions<DataType>
Options for storing the data.
Returns
void
Defined in
packages/near-sdk-js/src/collections/lookup-map.ts:102
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/lookup-map.ts:37
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/lookup-map.ts:57
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/lookup-map.ts:116
set(
key,newValue,options?):DataType
Store a new value at the provided key.
Parameters
• key: string
The key at which to store in the collection.
• newValue: 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/lookup-map.ts:79
set_reconstructor(
options?):Omit<GetOptions<DataType>,"serializer">
Parameters
• options?: Omit<GetOptions<DataType>, "serializer">
Returns
Omit<GetOptions<DataType>, "serializer">
Inherited from
Defined in
packages/near-sdk-js/src/collections/subtype.ts:8
subtype():
any
Returns
any
Inherited from
Defined in
packages/near-sdk-js/src/collections/subtype.ts:6
staticreconstruct<DataType>(data):LookupMap<DataType>
Converts the deserialized data from storage to a JavaScript instance of the collection.
Type Parameters
• DataType
Parameters
• data: LookupMap<unknown>
The deserialized data to create an instance from.
Returns
LookupMap<DataType>
Defined in