API documentation of Agoric SDK / Exports / @agoric/store / types / MapStore
Interface: MapStore<K, V>
@agoric/store.types.MapStore
Type parameters
Name | Type |
---|---|
K | extends Key = Key |
V | extends Passable = Passable |
Table of contents
Properties
Properties
addAll
• addAll: (entries
: CopyMap
<K
, V
> | Iterable
<[K
, V
]>) => void
Type declaration
▸ (entries
): void
Parameters
Name | Type |
---|---|
entries | CopyMap <K , V > | Iterable <[K , V ]> |
Returns
void
Defined in
packages/store/src/types.js:123
clear
• clear: (keyPatt?
: any
, valuePatt?
: any
) => void
Type declaration
▸ (keyPatt?
, valuePatt?
): void
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
void
Defined in
packages/store/src/types.js:129
delete
• delete: (key
: K
) => void
Remove the key. Throws if not found.
Type declaration
▸ (key
): void
Parameters
Name | Type |
---|---|
key | K |
Returns
void
Defined in
packages/store/src/types.js:122
entries
• entries: (keyPatt?
: any
, valuePatt?
: any
) => Iterable
<[K
, V
]>
Type declaration
▸ (keyPatt?
, valuePatt?
): Iterable
<[K
, V
]>
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
Iterable
<[K
, V
]>
Defined in
packages/store/src/types.js:126
get
• get: (key
: K
) => V
Return a value for the key. Throws if not found.
Type declaration
▸ (key
): V
Parameters
Name | Type |
---|---|
key | K |
Returns
V
Defined in
packages/store/src/types.js:116
getSize
• getSize: (keyPatt?
: any
, valuePatt?
: any
) => number
Type declaration
▸ (keyPatt?
, valuePatt?
): number
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
number
Defined in
packages/store/src/types.js:128
has
• has: (key
: K
) => boolean
Check if a key exists. The key can be any JavaScript value, though the answer will always be false for keys that cannot be found in this map
Type declaration
▸ (key
): boolean
Parameters
Name | Type |
---|---|
key | K |
Returns
boolean
Defined in
packages/store/src/types.js:113
init
• init: (key
: K
, value
: V
) => void
Initialize the key only if it doesn't already exist. The key must be one allowed by this store. For example a scalar store only allows primitives and remotables.
Type declaration
▸ (key
, value
): void
Parameters
Name | Type |
---|---|
key | K |
value | V |
Returns
void
Defined in
packages/store/src/types.js:118
keys
• keys: (keyPatt?
: any
, valuePatt?
: any
) => Iterable
<K
>
Type declaration
▸ (keyPatt?
, valuePatt?
): Iterable
<K
>
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
Iterable
<K
>
Defined in
packages/store/src/types.js:124
set
• set: (key
: K
, value
: V
) => void
Set the key. Throws if not found.
Type declaration
▸ (key
, value
): void
Parameters
Name | Type |
---|---|
key | K |
value | V |
Returns
void
Defined in
packages/store/src/types.js:121
snapshot
• snapshot: (keyPatt?
: any
, valuePatt?
: any
) => CopyMap
<K
, V
>
Type declaration
▸ (keyPatt?
, valuePatt?
): CopyMap
<K
, V
>
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
CopyMap
<K
, V
>
Defined in
packages/store/src/types.js:127
values
• values: (keyPatt?
: any
, valuePatt?
: any
) => Iterable
<V
>
Type declaration
▸ (keyPatt?
, valuePatt?
): Iterable
<V
>
Parameters
Name | Type |
---|---|
keyPatt? | any |
valuePatt? | any |
Returns
Iterable
<V
>