Class LookupMap<DataType>

constructor

• new LookupMap<DataType>(keyPrefix): LookupMap<DataType>

• Type Parameters

  • DataType

  Parameters

  • keyPrefix: string

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

  Returns LookupMap<DataType>

Readonly keyPrefix

containsKey

• containsKey(key): boolean

• Checks whether the collection contains the value.

  Parameters

  • key: string

    The value for which to check the presence.

  Returns boolean

extend

• 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.

  • Optional options: GetOptions<DataType>

    Options for storing the data.

  Returns void

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.

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

    Options for retrieving the data.

  Returns DataType

remove

• remove(key, options?): DataType

• Removes and retrieves the element with the provided key.

  Parameters

  • key: string

    The key at which to remove data.

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

    Options for retrieving the data.

  Returns DataType

serialize

• serialize(options?): Uint8Array

• Serialize the collection.

  Parameters

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

    Options for storing the data.

  Returns Uint8Array

set

• 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.

  • Optional options: GetOptions<DataType>

    Options for retrieving and storing the data.

  Returns DataType

Static reconstruct

• reconstruct<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>