Class TransactionalMap<K, V>

Map decorator that supports commit and rollback operations, any changes to the underlying map are only persisted when commit is called. Before any changes to the map are commited they can be reverted by calling rollback. A transaction is automaticlly started once any when calling delete, set or clear. At any given moment in time there can only be a single open transaction.

The transaction is implemented by creating a shallow clone from the target map; this is a less efficient implementation but has benefits when it comes to implementation complexcity

Type Parameters

Implements

Map<K, V>

Index

Constructors

constructor

new TransactionalMap<K, V>(inner?: Map<K, V>): TransactionalMap<K, V>
Type Parameters
- K
- V
Parameters
- inner: Map<K, V> = ...
Returns TransactionalMap<K, V>
- Defined in packages/util/src/transactionalMap.ts:11

Properties

`Private`inner

inner: Map<K, V> = ...

`Private`pending

pending: undefined | Map<K, V>

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Implementation of Map.[toStringTag]
- Defined in packages/util/src/transactionalMap.ts:14

size

get size(): number
Returns number
the number of elements in the Map.
Implementation of Map.size
- Defined in packages/util/src/transactionalMap.ts:18

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns MapIterator<[K, V]>
Implementation of Map.[iterator]
- Defined in packages/util/src/transactionalMap.ts:48

clear

clear(): void
Returns void
Implementation of Map.clear
- Defined in packages/util/src/transactionalMap.ts:52

commit

commit(): this
Returns this
- Defined in packages/util/src/transactionalMap.ts:27

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/util/src/transactionalMap.ts:56

entries

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

Returns MapIterator<[K, V]>
Implementation of Map.entries
- Defined in packages/util/src/transactionalMap.ts:35

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, 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: K, map: Map<K, V>) => void
- OptionalthisArg: any
Returns void
Implementation of Map.forEach
- Defined in packages/util/src/transactionalMap.ts:60

get

get(key: K): undefined | V
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: K
Returns undefined | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Implementation of Map.get
- Defined in packages/util/src/transactionalMap.ts:70

`Private`getConstant

getConstant(): Map<K, V>
Returns Map<K, V>
- Defined in packages/util/src/transactionalMap.ts:87

`Private`getModifiyable

getModifiyable(): Map<K, V>
Returns Map<K, V>
- Defined in packages/util/src/transactionalMap.ts:83

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of Map.has
- Defined in packages/util/src/transactionalMap.ts:74

keys

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

Returns MapIterator<K>
Implementation of Map.keys
- Defined in packages/util/src/transactionalMap.ts:40

rollback

rollback(): this
Returns this
- Defined in packages/util/src/transactionalMap.ts:22

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/util/src/transactionalMap.ts:78

values

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

Returns MapIterator<V>
Implementation of Map.values
- Defined in packages/util/src/transactionalMap.ts:44

Class TransactionalMap<K, V>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TransactionalMap<K, V>

Properties

Privateinner

Privatepending

Accessors

[toStringTag]

Returns string

size

Returns number

Methods

[iterator]

Returns MapIterator<[K, V]>

clear

Returns void

commit

Returns this

delete

Parameters

Returns boolean

entries

Returns MapIterator<[K, V]>

forEach

Parameters

Returns void

get

Parameters

Returns undefined | V

PrivategetConstant

Returns Map<K, V>

PrivategetModifiyable

Returns Map<K, V>

has

Parameters

Returns boolean

keys

Returns MapIterator<K>

rollback

Returns this

set

Parameters

Returns this

values

Returns MapIterator<V>

Settings

On This Page

`Private`inner

`Private`pending

`Private`getConstant

`Private`getModifiyable