Class ReplicatedMultiMap<Key, Value>

A replicated multimap (map of sets).

A replicated map that maps keys to values, where each key may be associated with multiple values.

Type Parameters

Key extends Serializable = Serializable

Type of keys for the Replicated Multi-Map
Value extends Serializable = Serializable

Type of values for the Replicated Multi-Map

Hierarchy

ReplicatedMultiMap

Implements

ReplicatedData

Index

Constructors

constructor

Methods

Accessors

Constructors

constructor

new ReplicatedMultiMap<Key, Value>(): ReplicatedMultiMap<Key, Value>

Type Parameters
- Key extends Serializable = Serializable
- Value extends Serializable = Serializable
Returns ReplicatedMultiMap<Key, Value>

Methods

get

get(key: Key): Set<Value>

- Defined in src/replicated-data/multi-map.ts:59
Get the values for the given key.

Parameters
- key: Key
  
  The key of the entry
Returns Set<Value>
The current values at the given key, or an empty Set

put

put(key: Key, value: Value): ReplicatedMultiMap<Key, Value>

- Defined in src/replicated-data/multi-map.ts:71
Store a key-value pair.

Parameters
- key: Key
  
  The key of the entry
- value: Value
  
  The value to add to the entry
Returns ReplicatedMultiMap<Key, Value>
This multimap

putAll

putAll(key: Key, values: Iterable<Value>): ReplicatedMultiMap<Key, Value>

- Defined in src/replicated-data/multi-map.ts:83
Store multiple values for a key.

Parameters
- key: Key
  
  The key of the entry
- values: Iterable<Value>
  
  The values to add to the entry
Returns ReplicatedMultiMap<Key, Value>
This multimap

delete

delete(key: Key, value: Value): ReplicatedMultiMap<Key, Value>

- Defined in src/replicated-data/multi-map.ts:98
Delete a single key-value pair for the given key and value.

Parameters
- key: Key
  
  The key of the entry
- value: Value
  
  The value to remove from the entry
Returns ReplicatedMultiMap<Key, Value>
This multimap

deleteAll

deleteAll(key: Key): ReplicatedMultiMap<Key, Value>

- Defined in src/replicated-data/multi-map.ts:114
Delete all values associated with the given key.

Parameters
- key: Key
  
  The key of the entry
Returns ReplicatedMultiMap<Key, Value>
This multimap

has

has(key: Key): boolean

- Defined in src/replicated-data/multi-map.ts:129
Check whether this multimap contains at least one value for the given key.

Parameters
- key: Key
  
  The key to check
Returns boolean
True if this multimap contains any values for the given key

hasValue

hasValue(key: Key, value: Value): boolean

- Defined in src/replicated-data/multi-map.ts:141
Check whether this multimap contains the given value associated with the given key.

Parameters
- key: Key
  
  The key to check
- value: Value
  
  The value to check
Returns boolean
True if the key-value pair is in this multimap

keys

keys(): IterableIterator<Key>

- Defined in src/replicated-data/multi-map.ts:169
Return an (iterable) iterator of the keys of this multimap.

Returns IterableIterator<Key>
(iterable) iterator of multimap keys

clear

clear(): ReplicatedMultiMap<Key, Value>

- Defined in src/replicated-data/multi-map.ts:178
Clear all entries from this multimap.

Returns ReplicatedMultiMap<Key, Value>
This multimap

toString

toString(): string

- Defined in src/replicated-data/multi-map.ts:266
Returns string

Accessors

size

get size(): number

- Defined in src/replicated-data/multi-map.ts:150
The total number of values stored in the multimap.

Returns number

keysSize

get keysSize(): number

- Defined in src/replicated-data/multi-map.ts:160
The number of keys with values stored in the multimap.

Returns number

Generated using TypeDoc