Class ObjectMap<V>

A map that is backed by an object-like map. Use objectMap to create it.

Type Parameters

V

Hierarchy

objectMapBase
- ObjectMap

Implements

Map<string, V>

Index

Constructors

Properties

[fromSnapshotOverrideTypeSymbol] [modelIdPropertyNameSymbol] [propsTypeSymbol] [toSnapshotOverrideTypeSymbol] [toStringTag] $ $modelType items

Accessors

Methods

[iterator] clear delete entries forEach get getRefId has keys set toString typeCheck values

Constructors

`Abstract`constructor

new ObjectMap<V>(data: any): ObjectMap<V>
Type Parameters
- V
Parameters
- data: any
Returns ObjectMap<V>
Inherited from objectMapBase.constructor

Properties

[fromSnapshotOverrideTypeSymbol]

"[fromSnapshotOverrideTypeSymbol]": any

[modelIdPropertyNameSymbol]

"[modelIdPropertyNameSymbol]": any

[propsTypeSymbol]

"[propsTypeSymbol]": any

[toSnapshotOverrideTypeSymbol]

"[toSnapshotOverrideTypeSymbol]": any

`Readonly`[toStringTag]

"[toStringTag]": "ObjectMap"

`Readonly`$

$: { items: Record<string, V> }

`Readonly`$modelType

$modelType: string

Model type name.

`Readonly`items

items: Record<string, V>

Accessors

$modelId

get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>
Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

Returns ModelIdPropertyType<TProps, ModelIdPropertyName>
Inherited from objectMapBase.$modelId
set $modelId(newId: ModelIdPropertyType<TProps, ModelIdPropertyName>): void
Parameters
- newId: ModelIdPropertyType<TProps, ModelIdPropertyName>
Returns void
Inherited from objectMapBase.$modelId

size

get size(): number
Returns number
the number of elements in the Map.

Implementation of Map.size

Methods

[iterator]

"[iterator]"(): MapIterator<[string, V]>
Returns MapIterator<[string, V]>
Implementation of Map.[iterator]

clear

clear(): void
Returns void
Implementation of Map.clear

delete

delete(key: string): boolean
Parameters
- key: string
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

entries

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

Returns MapIterator<[string, V]>
Implementation of Map.entries

forEach

forEach(
callbackfn: (value: V, key: string, map: Map<string, V>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: string, map: Map<string, V>) => void
- OptionalthisArg: any
Returns void
Implementation of Map.forEach

get

get(key: string): V | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: string
Returns V | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

Implementation of Map.get

getRefId

getRefId(): string | undefined
Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

Returns string | undefined
Inherited from objectMapBase.getRefId

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.

Implementation of Map.has

keys

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

Returns MapIterator<string>
Implementation of Map.keys

set

set(key: string, 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: string
- value: V
Returns this
Implementation of Map.set

toString

toString(options?: { withData?: boolean }): string
Parameters
- Optionaloptions: { withData?: boolean }
Returns string
Inherited from objectMapBase.toString

typeCheck

typeCheck(): TypeCheckError | null
Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

Returns TypeCheckError | null
A TypeCheckError or null if there is no error.

Inherited from objectMapBase.typeCheck

values

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

Returns MapIterator<V>
Implementation of Map.values