Class: KeyvAdapter<V>

Keyv adapter for Flashcore.

Wraps any Keyv-compatible instance, including:

• In-memory (default Keyv)
• Redis (@keyv/redis)
• MongoDB (@keyv/mongo)
• PostgreSQL (@keyv/postgres)
• MySQL (@keyv/mysql)
• SQLite (@keyv/sqlite)
• And many more...

Limitations:

• No scan capability (Keyv doesn't expose key listing)
• No atomic batch operations
• No setIfNotExists
• WAL recovery is disabled
• Bulk operations are disabled

Use this adapter for simple KV storage when you need external storage but don't need advanced features.

Type Parameters

Implements

• FlashcoreAdapter<string, V>

Constructors

new KeyvAdapter()

new KeyvAdapter<V>(keyv, options): KeyvAdapter<V>

Parameters

Returns

KeyvAdapter<V>

Properties

Methods

clear()

clear(): Promise<void>

Clear all data.

Returns

Promise<void>

Implementation of

FlashcoreAdapter.clear

delete()

delete(key): Promise<boolean>

Delete a key. Returns true if the key existed and was deleted.

Parameters

Returns

Promise<boolean>

Implementation of

FlashcoreAdapter.delete

get()

get(key): Promise<V>

Get a value by key. Returns undefined if the key does not exist.

Parameters

Returns

Promise<V>

Implementation of

FlashcoreAdapter.get

has()

has(key): Promise<boolean>

Check if a key exists. Must return true for stored falsy values (0, false, '', null).

Parameters

Returns

Promise<boolean>

Implementation of

FlashcoreAdapter.has

init()

init(): void

Initialize the adapter (e.g., connect, create directories). Called once during Flashcore.$.init().

Returns

void

Implementation of

FlashcoreAdapter.init

set()

set(key, value): Promise<boolean>

Set a key-value pair. Returns true if the operation succeeded.

Parameters

Returns

Promise<boolean>

Implementation of

FlashcoreAdapter.set