Skip to main content

LeaseStore

@totemsdk/server

@totemsdk/server / LeaseStore

Class: LeaseStore

Constructors​

Constructor​

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

Parameters​

storage​

StorageAdapter

logger?​

LoggerAdapter

config?​

LeaseStoreConfig

Returns​

LeaseStore

Methods​

calculateMonitoringInterval()​

calculateMonitoringInterval(): number

Returns​

number

cleanupExpired()​

cleanupExpired(): Promise<number>

Returns​

Promise<number>

clear()​

clear(): Promise<void>

Returns​

Promise<void>

delete()​

delete(leaseId): Promise<boolean>

Parameters​

leaseId​

string

Returns​

Promise<boolean>

deleteByToken()​

deleteByToken(leaseToken): Promise<boolean>

Parameters​

leaseToken​

string

Returns​

Promise<boolean>

get()​

get(leaseId): StoredLease | undefined

Parameters​

leaseId​

string

Returns​

StoredLease | undefined

getActive()​

getActive(): StoredLease[]

Returns​

StoredLease[]

getAll()​

getAll(): StoredLease[]

Returns​

StoredLease[]

getByToken()​

getByToken(leaseToken): StoredLease | undefined

Parameters​

leaseToken​

string

Returns​

StoredLease | undefined

getExpiringSoon()​

getExpiringSoon(thresholdMs?): StoredLease[]

Parameters​

thresholdMs?​

number

Returns​

StoredLease[]

getMinimumTTL()​

getMinimumTTL(): number | null

Returns​

number | null

initialize()​

initialize(): Promise<void>

Returns​

Promise<void>

isInitialized()​

isInitialized(): boolean

Returns​

boolean

save()​

save(lease): Promise<void>

Parameters​

lease​

StoredLease

Returns​

Promise<void>

updateStatus()​

updateStatus(leaseId, status): Promise<void>

Parameters​

leaseId​

string

status​

LeaseStatus

Returns​

Promise<void>