Interface IKvNamespace

A Workers KV namespace binding.

Since

0.2.0

interface IKvNamespace {
    delete(key: string): Promise<void>;
    get(key: string): Promise<string | null>;
    list(options?: KvListOptions): Promise<KvListResult>;
    put(key: string, value: string, options?: KvPutOptions): Promise<void>;
}

Index

Methods

delete get list put

Methods

delete

delete(key: string): Promise<void>
Removes a value. Succeeds whether or not the key existed.
Parameters
- key: string
  The key to remove
Returns Promise<void>
- Defined in packages/cloudflare-plugin/src/bindings/facades.ts:44

get

get(key: string): Promise<string | null>
Reads a value as text.
Parameters
- key: string
  The key, at most 512 bytes
Returns Promise<string | null>
The stored string, or null when absent or expired
- Defined in packages/cloudflare-plugin/src/bindings/facades.ts:29

list

list(options?: KvListOptions): Promise<KvListResult>
Lists keys, one page at a time.
Parameters
- Optionaloptions: KvListOptions
  Prefix filter, page size (1000 maximum), and cursor
Returns Promise<KvListResult>
One page of keys plus the pagination state
- Defined in packages/cloudflare-plugin/src/bindings/facades.ts:51

put

put(key: string, value: string, options?: KvPutOptions): Promise<void>
Writes a value.
Parameters
- key: string
  The key, at most 512 bytes
- value: string
  The value, at most 25 MiB
- Optionaloptions: KvPutOptions
  expirationTtl is in seconds and has a platform minimum of 60; a smaller value is rejected by KV
Returns Promise<void>
- Defined in packages/cloudflare-plugin/src/bindings/facades.ts:38

Interface IKvNamespace

Since

Index

Methods

Methods

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<string | null>

list

Parameters

Returns Promise<KvListResult>

put

Parameters

Returns Promise<void>

Settings

On This Page