Interface OfflineRegionCacheAdmin

Atomic lifecycle operations for a persistent offline-region cache. Implementations must advance the inventory revision once for each mutation.

interface OfflineRegionCacheAdmin {
    pruneExpired(now?: Date): Promise<readonly string[]>;
    removeRegion(regionId: string): Promise<boolean>;
    setRegionPinned(regionId: string, pinned: boolean): Promise<boolean>;
}

Implemented by

Index

Methods

pruneExpired removeRegion setRegionPinned

Methods

pruneExpired

pruneExpired(now?): Promise<readonly string[]>
Remove all regions expired at or before now, returning ids in inventory order.
Parameters
- Optionalnow: Date
Returns Promise<readonly string[]>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:179

removeRegion

removeRegion(regionId): Promise<boolean>
Remove a region and all of its resources. Returns false when absent.
Parameters
- regionId: string
Returns Promise<boolean>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:175

setRegionPinned

setRegionPinned(regionId, pinned): Promise<boolean>
Change whether automatic admission may evict a region. Returns false when unchanged or absent.
Parameters
- regionId: string
- pinned: boolean
Returns Promise<boolean>
- Defined in work/honua-sdk-js/honua-sdk-js/src/offline/types.ts:177