Class SingleFieldValueHolderMap<TFields, N, V>

Map from load value interface to value.

Type Parameters

TFields extends Record<string, any>
N extends keyof TFields
V

Hierarchy (View Summary, Expand)

LoadValueMap<NonNullable<TFields[N]>, SingleFieldValueHolder<TFields, N>, V>
- SingleFieldValueHolderMap

Index

Constructors

constructor

new SingleFieldValueHolderMap<
    TFields extends Record<string, any>,
    N extends string | number | symbol,
    V,
>(
    iterable?:
        | null
        | Iterable<readonly [SingleFieldValueHolder<TFields, N>, V], any, any>,
): SingleFieldValueHolderMap<TFields, N, V>
Type Parameters
- TFields extends Record<string, any>
- N extends string | number | symbol
- V
Parameters
- Optionaliterable: null | Iterable<readonly [SingleFieldValueHolder<TFields, N>, V], any, any>
Returns SingleFieldValueHolderMap<TFields, N, V>
Inherited from LoadValueMap.constructor
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:17

Properties

`Protected` `Readonly`underlyingMap

underlyingMap: Map<NonNullable<TFields[N]>, V>

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Inherited from LoadValueMap.[toStringTag]
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:81

size

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

Methods

[iterator]

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

clear

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

delete

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

`Protected`deserializeKey

deserializeKey(
serializedKey: NonNullable<TFields[N]>,
): SingleFieldValueHolder<TFields, N>
Parameters
- serializedKey: NonNullable<TFields[N]>
Returns SingleFieldValueHolder<TFields, N>
Overrides LoadValueMap.deserializeKey
- Defined in packages/entity/src/internal/SingleFieldHolder.ts:126

entries

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

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

forEach

forEach(
    callbackfn: (
        value: V,
        key: SingleFieldValueHolder,
        map: SerializableKeyMap<
            NonNullable<TFields[N]>,
            SingleFieldValueHolder<TFields, N>,
            V,
        >,
    ) => void,
    thisArg?: any,
): void
Parameters
- callbackfn: (
      value: V,
      key: SingleFieldValueHolder,
      map: SerializableKeyMap<
          NonNullable<TFields[N]>,
          SingleFieldValueHolder<TFields, N>,
          V,
      >,
  ) => void
- OptionalthisArg: any
Returns void
Inherited from LoadValueMap.forEach
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:25

get

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

has

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

keys

keys(): MapIterator<SingleFieldValueHolder<TFields, N>>
Returns an iterable of keys in the map

Returns MapIterator<SingleFieldValueHolder<TFields, N>>
Inherited from LoadValueMap.keys
- Defined in packages/entity/src/utils/collections/SerializableKeyMap.ts:65

set

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

Class SingleFieldValueHolderMap<TFields, N, V>

Type Parameters

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SingleFieldValueHolderMap<TFields, N, V>

Properties

Protected ReadonlyunderlyingMap

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

[iterator]

Returns MapIterator<[SingleFieldValueHolder<TFields, N>, V]>

clear

Returns void

delete

Parameters

Returns boolean

ProtecteddeserializeKey

Parameters

Returns SingleFieldValueHolder<TFields, N>

entries

Returns MapIterator<[SingleFieldValueHolder<TFields, N>, V]>

forEach

Parameters

Returns void

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

keys

Returns MapIterator<SingleFieldValueHolder<TFields, N>>

set

Parameters

Returns this

values

Returns MapIterator<V>

Settings

On This Page

`Protected` `Readonly`underlyingMap

`Protected`deserializeKey