Class UnorderedMap<DataType>

constructor

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

• Type Parameters

  • DataType

  Parameters

  • prefix: string

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

  Returns UnorderedMap<DataType>

Readonly _keys

Readonly prefix

Readonly values

length

• get length(): number

• The number of elements stored in the collection.

  Returns number

[iterator]

• [iterator](): UnorderedMapIterator<DataType>

• Returns UnorderedMapIterator<DataType>

clear

• clear(): void

• Remove all of the elements stored within the collection.

  Returns void

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

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

isEmpty

• isEmpty(): boolean

• Checks whether the collection is empty.

  Returns boolean

keys

• keys(__namedParameters): string[]

• Parameters

  • __namedParameters: {
        limit: any;
        start: any;
    }

    • limit: any

    • start: any

  Returns string[]

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

  • Optional options: GetOptions<DataType>

    Options for retrieving and storing the data.

  Returns DataType

toArray

• toArray(options?): [string, 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 [string, DataType][]

Static reconstruct

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