Class LoadValueMap<TSerialized, TLoadValue, V>`Abstract`

Map from load value interface to value.

Type Parameters

TSerialized
TLoadValue extends IEntityLoadValue<TSerialized>
V

Hierarchy (View Summary)

SerializableKeyMap<TSerialized, TLoadValue, V>
- LoadValueMap
  - CompositeFieldValueHolderMap
  - SingleFieldValueHolderMap

Index

Constructors

constructor

new LoadValueMap<
    TSerialized,
    TLoadValue extends IEntityLoadValue<TSerialized>,
    V,
>(
    iterable?: null | Iterable<readonly [TLoadValue, V], any, any>,
): LoadValueMap<TSerialized, TLoadValue, V>
Type Parameters
- TSerialized
- TLoadValue extends IEntityLoadValue<TSerialized>
- V
Parameters
- Optionaliterable: null | Iterable<readonly [TLoadValue, V], any, any>
Returns LoadValueMap<TSerialized, TLoadValue, V>
Inherited from SerializableKeyMap.constructor
- 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
Inherited from SerializableKeyMap.[toStringTag]
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:81

size

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

Methods

[iterator]

"[iterator]"(): MapIterator<[TLoadValue, V]>
Returns MapIterator<[TLoadValue, V]>
Inherited from SerializableKeyMap.[iterator]
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:77

clear

clear(): void
Returns void
Inherited from SerializableKeyMap.clear
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:42

delete

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

`Protected` `Abstract`deserializeKey

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

entries

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

Returns MapIterator<[TLoadValue, V]>
Inherited from SerializableKeyMap.entries
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:59

forEach

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

get

get(key: TLoadValue): undefined | V
Parameters
- key: TLoadValue
Returns undefined | V
Inherited from SerializableKeyMap.get
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:34

has

has(key: TLoadValue): boolean
Parameters
- key: TLoadValue
Returns boolean
Inherited from SerializableKeyMap.has
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:38

keys

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

Returns MapIterator<TLoadValue>
Inherited from SerializableKeyMap.keys
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:65

set

set(key: TLoadValue, 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: TLoadValue
- value: V
Returns this
Inherited from SerializableKeyMap.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>
Inherited from SerializableKeyMap.values
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:71

Class LoadValueMap<TSerialized, TLoadValue, V>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LoadValueMap<TSerialized, TLoadValue, V>

Properties

Protected ReadonlyunderlyingMap

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

[iterator]

Returns MapIterator<[TLoadValue, V]>

clear

Returns void

delete

Parameters

Returns boolean

Protected AbstractdeserializeKey

Parameters

Returns TLoadValue

entries

Returns MapIterator<[TLoadValue, V]>

forEach

Parameters

Returns void

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

keys

Returns MapIterator<TLoadValue>

set

Parameters

Returns this

values

Returns MapIterator<V>

Settings

On This Page

Class LoadValueMap<TSerialized, TLoadValue, V>`Abstract`

`Protected` `Readonly`underlyingMap

`Protected` `Abstract`deserializeKey