Type Alias KV

KV: RoKV & {
    create(k: string, data: Payload): Promise<number>;
    delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
    destroy(): Promise<boolean>;
    purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>;
    put(
        k: string,
        data: Payload,
        opts?: Partial<KvPutOptions>,
    ): Promise<number>;
    update(k: string, data: Payload, version: number): Promise<number>;
}

Type declaration

  • create:function
    • 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>

  • delete:function
    • 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

      Returns Promise<void>

  • destroy:function
    • destroy(): Promise<boolean>

      Destroys the underlying stream used by the KV. This effectively deletes all data stored under the KV.

      Returns Promise<boolean>

  • purge:function
    • purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

      Deletes and purges the specified key and any value history.

      Parameters

      Returns Promise<void>

  • put:function
    • put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>

      Sets or updates the value stored under the specified key.

      Parameters

      Returns Promise<number>

  • update:function
    • 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>

Settings

Member Visibility