Class GKV<K, V>

constructor

• new GKV<K = string, V = unknown>(
      __namedParameters: {
          bucket: string;
          getBlobPath?: (namespace: string, key: K) => string;
          log?: Log;
          namespace?: string;
          storage: Storage;
      },
  ): GKV<K, V>

  Type Parameters

  • K = string
  • V = unknown

  Parameters

  • __namedParameters: {
        bucket: string;
        getBlobPath?: (namespace: string, key: K) => string;
        log?: Log;
        namespace?: string;
        storage: Storage;
    }

  Returns GKV<K, V>

bucket

getBlobPath

Optionallog

namespace

storage

delete

• delete(key: K): Promise<{ key: K; status: "deleted" | "error" }>

  Delete a key value pair

  Parameters

  • key: K

  Returns Promise<{ key: K; status: "deleted" | "error" }>

get

• get(key: K): Promise<{ key: K; value: undefined | V }>

  Get a value via its key

  Parameters

  • key: K

  Returns Promise<{ key: K; value: undefined | V }>

set

• set(key: K, value: V): Promise<{ key: K; value: undefined | V }>

  Set a new value, or overwrite an existing value

  Parameters

  • key: K
  • value: V

  Returns Promise<{ key: K; value: undefined | V }>

update

• update(key: K, value: V): Promise<{ key: K; value: undefined | V }>

  Update an existing value. Supports partial updates of deep objects

  Parameters

  • key: K
  • value: V

  Returns Promise<{ key: K; value: undefined | V }>