Class CloudflareKvStore

constructor

• new CloudflareKvStore(options?: CloudflareKvStoreOptions): CloudflareKvStore

  Parameters

  • options: CloudflareKvStoreOptions = {}

  Returns CloudflareKvStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): CloudflareKvHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns CloudflareKvHttpClient

get

• get(key: string): Promise<string | null>

  Read a key. Returns null on a 404 (missing key).

  Parameters

  • key: string

  Returns Promise<string | null>

set

• set(
      key: string,
      value: unknown,
      options?: CloudflareKvSetOptions,
  ): Promise<void>

  Write value under key. Strings are stored verbatim; other values are JSON-serialized. options.ttl maps to expiration_ttl (seconds), options.expiration to expiration (absolute Unix seconds).

  Parameters

  • key: string
  • value: unknown
  • options: CloudflareKvSetOptions = {}

  Returns Promise<void>

del

• del(key: string): Promise<void>

  Delete a key.

  Parameters

  • key: string

  Returns Promise<void>

list

• list(prefix?: string): Promise<string[]>

  List key names, optionally filtered by prefix.

  Parameters

  • Optionalprefix: string

  Returns Promise<string[]>

incr

• incr(key: string, by?: number): Promise<number>

  Increment the numeric value at key by by (default 1). Workers KV has no atomic increment, so this is a non-atomic read-modify-write.

  Parameters

  • key: string
  • by: number = 1

  Returns Promise<number>