Class VercelKvStore

constructor

• new VercelKvStore(options?: VercelKvStoreOptions): VercelKvStore

  Parameters

  • options: VercelKvStoreOptions = {}

  Returns VercelKvStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): VercelKvClient

  Returns the underlying @vercel/kv client for anything not wrapped here.

  Returns VercelKvClient

get

• get(key: string): Promise<any>

  Read a key. Returns whatever the client returns (null if missing).

  Parameters

  • key: string

  Returns Promise<any>

set

• set(key: string, value: unknown, options?: VercelKvSetOptions): Promise<any>

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

  Parameters

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

  Returns Promise<any>

del

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

  Delete a key. Returns the number of keys removed.

  Parameters

  • key: string

  Returns Promise<number>

list

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

  List key names, optionally filtered by prefix (matched as <prefix>*).

  Parameters

  • Optionalprefix: string

  Returns Promise<string[]>

incr

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

  Atomically increment the numeric value at key by by (default 1).

  Parameters

  • key: string
  • by: number = 1

  Returns Promise<number>