Interfacetypesv0.16.0

KvDriver

The backend behind config.kv. seedcord turns every value into JSON before it calls the driver, so a driver only stores and returns strings. Each method may return its result directly or as a promise.

config.kv also requires Disposable or AsyncDisposable on the driver. A node bot calls it after the last shutdown phase to close the backend.

interface KvDriver

delete()

delete(key: string): Promisable<void>

entries()

Every key that starts with prefix, prefix included, with its value. Throw if the backend can't list its keys.

entries(
    prefix: string
): AsyncIterable<KvEntry> | Iterable<KvEntry>

get()

get(
    key: string
): Promisable<string | undefined>

set()

set(
    key: string,
    value: string,
    ttlMs?: number
): Promisable<void>

Parameter: ttlMs

The backend may delete the key after this many milliseconds. Seedcord checks the expiry on read either way.