Interface KV

Hierarchy

RoKV
- KV

Index

Methods

close create delete destroy get history keys purge put status update watch

Methods

close

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

create

create(k: string, data: Payload): Promise<number>
Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.
Parameters
- k: string
- data: Payload
Returns Promise<number>
- Defined in cjs/jetstream/types.ts:1214

delete

delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>
Deletes the entry stored under the specified key. Deletes are soft-deletes. The server will add a new entry marked by a "DEL" operation. Note that if the KV was created with an underlying limit (such as a TTL on keys) it is possible for a key or the soft delete marker to be removed without additional notification on a watch.
Parameters
- k: string
- Optional opts: Partial<KvDeleteOptions>
Returns Promise<void>
- Defined in cjs/jetstream/types.ts:1249

destroy

destroy(): Promise<boolean>
Destroys the underlying stream used by the KV. This effectively deletes all data stored under the KV.

Returns Promise<boolean>
- Defined in cjs/jetstream/types.ts:1263

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>
Inherited from RoKV.get
- 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>>
Inherited from RoKV.history
- 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>>
Inherited from RoKV.keys
- Defined in cjs/jetstream/types.ts:1203

purge

purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>
Deletes and purges the specified key and any value history.
Parameters
- k: string
- Optional opts: Partial<KvDeleteOptions>
Returns Promise<void>
- Defined in cjs/jetstream/types.ts:1257

put

put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>
Sets or updates the value stored under the specified key.
Parameters
- k: string
- data: Payload
- Optional opts: Partial<KvPutOptions>
Returns Promise<number>
- Defined in cjs/jetstream/types.ts:1232

status

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

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

update

update(k: string, data: Payload, version: number): Promise<number>
Updates the existing entry provided that the previous sequence for the Kv is at the specified version. This ensures that the KV has not been modified prior to the update.
Parameters
- k: string
- data: Payload
- version: number
Returns Promise<number>
- Defined in cjs/jetstream/types.ts:1224

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>>
Inherited from RoKV.watch
- Defined in cjs/jetstream/types.ts:1184

Interface KV

Hierarchy

Index

Methods

Methods

close

Deprecated

Returns Promise<void>

create

Parameters

k: string

data: Payload

Returns Promise<number>

delete

Parameters

k: string

Optional opts: Partial<KvDeleteOptions>

Returns Promise<void>

destroy

Returns Promise<boolean>

get

Parameters

k: string

Optional opts: { revision: number; }

revision: number

Returns Promise<KvEntry>

history

Parameters

Optional opts: { key?: string; }

Optional key?: string

Returns Promise<QueuedIterator<KvEntry>>

keys

Parameters

Optional filter: string

Returns Promise<QueuedIterator<string>>

purge

Parameters

k: string

Optional opts: Partial<KvDeleteOptions>

Returns Promise<void>

put

Parameters

k: string

data: Payload

Optional opts: Partial<KvPutOptions>

Returns Promise<number>

status

Returns Promise<KvStatus>

update

Parameters

k: string

data: Payload

version: number

Returns Promise<number>

watch

Parameters

Optional opts: KvWatchOptions

Returns Promise<QueuedIterator<KvEntry>>

Settings

Member Visibility

Theme

`Optional` opts: Partial<KvDeleteOptions>

`Optional` opts: {
revision: number;
}

`Optional` opts: {
key?: string;
}

`Optional` key?: string

`Optional` filter: string

`Optional` opts: Partial<KvDeleteOptions>

`Optional` opts: Partial<KvPutOptions>

`Optional` opts: KvWatchOptions