Interface OfflineRegionStore

Storage adapter boundary; no browser or platform storage is selected by the SDK.

interface OfflineRegionStore {
    beginWrite(regionId: string): Promise<OfflineRegionWriteTransaction>;
    inventory(): Promise<OfflineRegionCacheInventory>;
    readResource(
        regionId: string,
        resourceId: string,
    ): Promise<OfflineRegionResourceRead | undefined>;
}

Implemented by

Index

Methods

beginWrite inventory readResource

Methods

beginWrite

beginWrite(regionId: string): Promise<OfflineRegionWriteTransaction>
Parameters
- regionId: string
Returns Promise<OfflineRegionWriteTransaction>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:295

inventory

inventory(): Promise<OfflineRegionCacheInventory>
Returns Promise<OfflineRegionCacheInventory>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:292

readResource

readResource(
regionId: string,
resourceId: string,
): Promise<OfflineRegionResourceRead | undefined>
Read one committed resource, or undefined when it is absent.
Parameters
- regionId: string
- resourceId: string
Returns Promise<OfflineRegionResourceRead | undefined>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:294