Class SerializableKeyMap<TSerialized, K, V>`Abstract`

A map with keys that are serializable. Serialized keys are considered equal if their serialized values are equal. Otherwise, the map behaves like a regular Map.

Type Parameters

TSerialized
K extends ISerializable<TSerialized>
V

Hierarchy (View Summary, Expand)

SerializableKeyMap
- LoadValueMap

Implements

ReadonlyMap<K, V>
Map<K, V>

Index

Constructors

Accessors

[toStringTag] size

Methods

[iterator] clear delete deserializeKey entries forEach get has keys set values

Constructors

constructor

new SerializableKeyMap<TSerialized, K extends ISerializable<TSerialized>, V>(
iterable?: null | Iterable<readonly [K, V], any, any>,
): SerializableKeyMap<TSerialized, K, V>
Type Parameters
- TSerialized
- K extends ISerializable<TSerialized>
- V
Parameters
- Optionaliterable: null | Iterable<readonly [K, V], any, any>
Returns SerializableKeyMap<TSerialized, K, V>
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:17

Properties

`Protected` `Readonly`underlyingMap

underlyingMap: Map<TSerialized, V>

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Map.[toStringTag]
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:81

size

get size(): number
Returns number
Implementation of ReadonlyMap.size
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:55

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns MapIterator<[K, V]>
Implementation of ReadonlyMap.[iterator]
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:77

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:42

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Implementation of Map.delete
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:46

`Protected` `Abstract`deserializeKey

deserializeKey(serializedKey: TSerialized): K
Parameters
- serializedKey: TSerialized
Returns K
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:23

entries

entries(): MapIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[K, V]>
Implementation of ReadonlyMap.entries
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:59

forEach

forEach(
    callbackfn: (
        value: V,
        key: K,
        map: SerializableKeyMap<TSerialized, K, V>,
    ) => void,
    thisArg?: any,
): void
Parameters
- callbackfn: (value: V, key: K, map: SerializableKeyMap<TSerialized, K, V>) => void
- OptionalthisArg: any
Returns void
Implementation of ReadonlyMap.forEach
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:25

get

get(key: K): undefined | V
Parameters
- key: K
Returns undefined | V
Implementation of ReadonlyMap.get
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:34

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
Implementation of ReadonlyMap.has
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:38

keys

keys(): MapIterator<K>
Returns an iterable of keys in the map

Returns MapIterator<K>
Implementation of ReadonlyMap.keys
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:65

set

set(key: K, value: V): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: K
- value: V
Returns this
Implementation of Map.set
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:50

values

values(): MapIterator<V>
Returns an iterable of values in the map

Returns MapIterator<V>
Implementation of ReadonlyMap.values
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:71