Interface RoKV

Hierarchy

RoKV
- KV

Index

Methods

close get history keys status watch

Methods

close

close(): Promise<void>
Deprecated
- this api is removed.
Returns Promise<void>
- Defined in cjs/jetstream/types.ts:1191

get

get(k: string, opts?: {
revision: number;
}): Promise<KvEntry>
Returns the KvEntry stored under the key if it exists or null if not. Note that the entry returned could be marked with a "DEL" or "PURGE" operation which signifies the server stored the value, but it is now deleted.
Parameters
- k: string
- Optional opts: {
  revision: number;
  }
  - revision: number
Returns Promise<KvEntry>
- Defined in cjs/jetstream/types.ts:1172

history

history(opts?: {
key?: string;
}): Promise<QueuedIterator<KvEntry>>
Returns an iterator of the specified key's history (or all keys).
Parameters
- Optional opts: {
  key?: string;
  }
  - Optional key?: string
Returns Promise<QueuedIterator<KvEntry>>
- Defined in cjs/jetstream/types.ts:1178

keys

keys(filter?: string): Promise<QueuedIterator<string>>
Returns an iterator of all the keys optionally matching the specified filter.
Parameters
- Optional filter: string
Returns Promise<QueuedIterator<string>>
- Defined in cjs/jetstream/types.ts:1203

status

status(): Promise<KvStatus>
Returns information about the Kv

Returns Promise<KvStatus>
- Defined in cjs/jetstream/types.ts:1196

watch

watch(opts?: KvWatchOptions): Promise<QueuedIterator<KvEntry>>
Returns an iterator that will yield KvEntry updates as they happen.
Parameters
- Optional opts: KvWatchOptions
Returns Promise<QueuedIterator<KvEntry>>
- Defined in cjs/jetstream/types.ts:1184

Generated using TypeDoc