KeyValueProvider

@daydreamsai/core


@daydreamsai/core / KeyValueProvider

Interface: KeyValueProvider

Defined in: packages/core/src/memory/types.ts:84

Key-Value storage provider

Extends

Methods

close()

close(): Promise<void>

Defined in: packages/core/src/memory/types.ts:71

Returns

Promise<void>

Inherited from

MemoryProvider.close


count()

count(pattern?): Promise<number>

Defined in: packages/core/src/memory/types.ts:90

Parameters

pattern?

string

Returns

Promise<number>


delete()

delete(key): Promise<boolean>

Defined in: packages/core/src/memory/types.ts:87

Parameters

key

string

Returns

Promise<boolean>


deleteBatch()

deleteBatch(keys): Promise<number>

Defined in: packages/core/src/memory/types.ts:96

Parameters

keys

string[]

Returns

Promise<number>


exists()

exists(key): Promise<boolean>

Defined in: packages/core/src/memory/types.ts:88

Parameters

key

string

Returns

Promise<boolean>


get()

get<T>(key): Promise<null | T>

Defined in: packages/core/src/memory/types.ts:85

Type Parameters

T

T

Parameters

key

string

Returns

Promise<null | T>


getBatch()

getBatch<T>(keys): Promise<Map<string, T>>

Defined in: packages/core/src/memory/types.ts:94

Type Parameters

T

T

Parameters

keys

string[]

Returns

Promise<Map<string, T>>


health()

health(): Promise<HealthStatus>

Defined in: packages/core/src/memory/types.ts:72

Returns

Promise<HealthStatus>

Inherited from

MemoryProvider.health


initialize()

initialize(): Promise<void>

Defined in: packages/core/src/memory/types.ts:70

Returns

Promise<void>

Inherited from

MemoryProvider.initialize


keys()

keys(pattern?): Promise<string[]>

Defined in: packages/core/src/memory/types.ts:89

Parameters

pattern?

string

Returns

Promise<string[]>


scan()

scan(pattern?): AsyncIterator<[string, unknown]>

Defined in: packages/core/src/memory/types.ts:91

Parameters

pattern?

string

Returns

AsyncIterator<[string, unknown]>


set()

set<T>(key, value, options?): Promise<void>

Defined in: packages/core/src/memory/types.ts:86

Type Parameters

T

T

Parameters

key

string

value

T

options?

SetOptions

Returns

Promise<void>


setBatch()

setBatch<T>(entries, options?): Promise<void>

Defined in: packages/core/src/memory/types.ts:95

Type Parameters

T

T

Parameters

entries

Map<string, T>

options?

SetOptions

Returns

Promise<void>