API documentation of Agoric SDK / Exports / @agoric/store / types / SetStore
Interface: SetStore<K>
@agoric/store.types.SetStore
Type parameters
| Name | Type |
|---|---|
K | extends Key = Key |
Table of contents
Properties
Properties
add
• add: (key: K) => void
Add the key to the set if it is not already there. Do nothing silently if already there. The key must be one allowed by this store. For example a scalar store only allows primitives and remotables.
Type declaration
▸ (key): void
Parameters
| Name | Type |
|---|---|
key | K |
Returns
void
Defined in
packages/store/src/types.js:79
addAll
• addAll: (keys: CopySet<K> | Iterable<K>) => void
Type declaration
▸ (keys): void
Parameters
| Name | Type |
|---|---|
keys | CopySet<K> | Iterable<K> |
Returns
void
Defined in
packages/store/src/types.js:84
clear
• clear: (keyPatt?: any) => void
Type declaration
▸ (keyPatt?): void
Parameters
| Name | Type |
|---|---|
keyPatt? | any |
Returns
void
Defined in
packages/store/src/types.js:89
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:83
getSize
• getSize: (keyPatt?: any) => number
Type declaration
▸ (keyPatt?): number
Parameters
| Name | Type |
|---|---|
keyPatt? | any |
Returns
number
Defined in
packages/store/src/types.js:88
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 store.
Type declaration
▸ (key): boolean
Parameters
| Name | Type |
|---|---|
key | K |
Returns
boolean
Defined in
packages/store/src/types.js:76
keys
• keys: (keyPatt?: any) => Iterable<K>
Type declaration
▸ (keyPatt?): Iterable<K>
Parameters
| Name | Type |
|---|---|
keyPatt? | any |
Returns
Iterable<K>
Defined in
packages/store/src/types.js:85
snapshot
• snapshot: (keyPatt?: any) => CopySet<K>
Type declaration
▸ (keyPatt?): CopySet<K>
Parameters
| Name | Type |
|---|---|
keyPatt? | any |
Returns
CopySet<K>
Defined in
packages/store/src/types.js:87
values
• values: (keyPatt?: any) => Iterable<K>
Type declaration
▸ (keyPatt?): Iterable<K>
Parameters
| Name | Type |
|---|---|
keyPatt? | any |
Returns
Iterable<K>