Class InMemoryKVStorage

In-memory implementation of KVStorage.

Implements every method on the contract plus a few NuxtHub-flavored aliases (set, del, keys, getItem, setItem, removeItem, getKeys) so the same instance can be wrapped by createNuxtHubKVProvider without any additional adapter glue.

Implements

KVStorage

Index

Constructors

constructor

Methods

clear del delete get getItem getKeys keys list put removeItem set setItem size

Constructors

constructor

new InMemoryKVStorage(): InMemoryKVStorage

Returns InMemoryKVStorage

Methods

clear

clear(): void
Drops every entry from the store. Test utility only — production implementations should not expose this affordance.

Returns void
- Defined in src/providers-memory.ts:2442

del

del(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in src/providers-memory.ts:2381

delete

delete(key: string): Promise<void>
Deletes a key.
Parameters
- key: string
Returns Promise<void>
Implementation of KVStorage.delete
- Defined in src/providers-memory.ts:2407

get

get<T = unknown>(key: string, type: "json"): Promise<T | null>
Retrieves a value by key. When type is json, the value should be parsed.
Type Parameters
- T = unknown
Parameters
- key: string
- type: "json"
Returns Promise<T | null>
Implementation of KVStorage.get
- Defined in src/providers-memory.ts:2334
get(key: string, type?: "text"): Promise<string | null>
Parameters
- key: string
- Optionaltype: "text"
Returns Promise<string | null>
Implementation of KVStorage.get
- Defined in src/providers-memory.ts:2335

getItem

getItem<T = unknown>(key: string): Promise<T | null>
Type Parameters
- T = unknown
Parameters
- key: string
Returns Promise<T | null>
- Defined in src/providers-memory.ts:2390

getKeys

getKeys(prefix?: string): Promise<string[]>
Parameters
- prefix: string = ''
Returns Promise<string[]>
- Defined in src/providers-memory.ts:2403

keys

keys(prefix?: string): Promise<string[]>
Parameters
- prefix: string = ''
Returns Promise<string[]>
- Defined in src/providers-memory.ts:2385

list

list(
options?: { cursor?: string; limit?: number; prefix?: string },
): Promise<KVListResult>
Lists keys, optionally filtered by prefix.
Parameters
- Optionaloptions: { cursor?: string; limit?: number; prefix?: string }
Returns Promise<KVListResult>
Implementation of KVStorage.list
- Defined in src/providers-memory.ts:2412

put

put(
    key: string,
    value: string,
    options?: { expirationTtl?: number },
): Promise<void>
Stores a value by key.
Parameters
- key: string
- value: string
- Optionaloptions: { expirationTtl?: number }
Returns Promise<void>
Implementation of KVStorage.put
- Defined in src/providers-memory.ts:2363

removeItem

removeItem(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in src/providers-memory.ts:2399

set

set(key: string, value: unknown, options?: { ttl?: number }): Promise<void>
Parameters
- key: string
- value: unknown
- Optionaloptions: { ttl?: number }
Returns Promise<void>
- Defined in src/providers-memory.ts:2372

setItem

setItem(key: string, value: unknown): Promise<void>
Parameters
- key: string
- value: unknown
Returns Promise<void>
- Defined in src/providers-memory.ts:2395

size

size(): number
Returns the number of non-expired entries currently in the store. Useful for asserting on cleanup behavior in tests.

Returns number
- Defined in src/providers-memory.ts:2451

Class InMemoryKVStorage

Implements

Index

Constructors

Methods

Constructors

constructor

Returns InMemoryKVStorage

Methods

clear

Returns void

del

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<T | null>

Parameters

Returns Promise<string | null>

getItem

Type Parameters

Parameters

Returns Promise<T | null>

getKeys

Parameters

Returns Promise<string[]>

keys

Parameters

Returns Promise<string[]>

list

Parameters

Returns Promise<KVListResult>

put

Parameters

Returns Promise<void>

removeItem

Parameters

Returns Promise<void>

set

Parameters

Returns Promise<void>

setItem

Parameters

Returns Promise<void>

size

Returns number

Settings

On This Page