API documentation of Agoric SDK / Exports / @agoric/zone / Stores
Interface: Stores
@agoric/zone.Stores
Table of contents
Properties
Properties
detached
• detached: () => Stores
obtain store providers which are detached (the stores are anonymous rather than bound to label in the zone)
Type declaration
▸ (): Stores
Returns
Defined in
packages/base-zone/src/types.js:23
isStorable
• isStorable: (specimen: unknown) => boolean
return true if the specimen can be stored in the zone, whether as exo-object state or in a store
Type declaration
▸ (specimen): boolean
Parameters
| Name | Type |
|---|---|
specimen | unknown |
Returns
boolean
Defined in
packages/base-zone/src/types.js:24
mapStore
• mapStore: <K, V>(label: string, options?: StoreOptions) => MapStore<K, V>
provide a Map-like store named label in the zone
Type declaration
▸ <K, V>(label, options?): MapStore<K, V>
Type parameters
| Name |
|---|
K |
V |
Parameters
| Name | Type |
|---|---|
label | string |
options? | StoreOptions |
Returns
MapStore<K, V>
Defined in
packages/base-zone/src/types.js:25
setStore
• setStore: <K>(label: string, options?: StoreOptions) => SetStore<K>
provide a Set-like store named label in the zone
Type declaration
▸ <K>(label, options?): SetStore<K>
Type parameters
| Name |
|---|
K |
Parameters
| Name | Type |
|---|---|
label | string |
options? | StoreOptions |
Returns
SetStore<K>
Defined in
packages/base-zone/src/types.js:26
weakMapStore
• weakMapStore: <K, V>(label: string, options?: StoreOptions) => WeakMapStore<K, V>
provide a WeakMap-like store named label in the zone
Type declaration
▸ <K, V>(label, options?): WeakMapStore<K, V>
Type parameters
| Name |
|---|
K |
V |
Parameters
| Name | Type |
|---|---|
label | string |
options? | StoreOptions |
Returns
WeakMapStore<K, V>
Defined in
packages/base-zone/src/types.js:29
weakSetStore
• weakSetStore: <K>(label: string, options?: StoreOptions) => WeakSetStore<K>
provide a WeakSet-like store named label in the zone
Type declaration
▸ <K>(label, options?): WeakSetStore<K>
Type parameters
| Name |
|---|
K |
Parameters
| Name | Type |
|---|---|
label | string |
options? | StoreOptions |
Returns
WeakSetStore<K>