Skip to main content

WatermarkStore

@totemsdk/core

@totemsdk/core / WatermarkStore

Class: WatermarkStore

Constructors​

Constructor​

new WatermarkStore(storage, logger?, config?): WatermarkStore

Parameters​

storage​

StorageAdapter

logger?​

LoggerAdapter = ...

config?​

WatermarkStoreConfig = {}

Returns​

WatermarkStore

Methods​

advanceWatermark()​

advanceWatermark(indices): Promise<void>

Parameters​

indices​

WotsIndices

Returns​

Promise<void>

clear()​

clear(): Promise<void>

Returns​

Promise<void>

getCurrent()​

getCurrent(): WatermarkState | null

Returns​

WatermarkState | null

getNextIndices()​

getNextIndices(): WotsIndices | null

Returns​

WotsIndices | null

getUsageStats()​

getUsageStats(): object

Returns​

object

percentage​

percentage: number

total​

total: number

used​

used: number

hasAvailableIndices()​

hasAvailableIndices(): boolean

Returns​

boolean

initialize()​

initialize(): Promise<WatermarkState>

Returns​

Promise<WatermarkState>

isExhausted()​

isExhausted(): boolean

Returns​

boolean

isInitialized()​

isInitialized(): boolean

Returns​

boolean

load()​

load(): Promise<WatermarkState | null>

Returns​

Promise<WatermarkState | null>

markUsed()​

markUsed(indices): Promise<void>

Parameters​

indices​

WotsIndices

Returns​

Promise<void>

save()​

save(watermark): Promise<void>

Parameters​

watermark​

WatermarkState

Returns​

Promise<void>

updateFromServer()​

updateFromServer(serverWatermark): Promise<SyncResult>

Parameters​

serverWatermark​

WotsIndices

Returns​

Promise<SyncResult>