Directus / @directus/memory / index / KvLocal

Class: KvLocal ​

Defined in: packages/memory/src/kv/lib/local.ts:6

Implements ​

• Kv

Constructors ​

new KvLocal() ​

new KvLocal(config): KvLocal

Defined in: packages/memory/src/kv/lib/local.ts:9

Parameters ​

config ​

Omit<KvConfigLocal, "type">

Returns ​

KvLocal

Methods ​

clear() ​

clear(): Promise<void>

Defined in: packages/memory/src/kv/lib/local.ts:72

Remove all keys from the kv store

Returns ​

Promise<void>

Implementation of ​

Kv.clear

delete() ​

delete(key): Promise<void>

Defined in: packages/memory/src/kv/lib/local.ts:34

Remove the given key from the store

Parameters ​

key ​

string

Key to remove from the store

Returns ​

Promise<void>

Implementation of ​

Kv.delete

get() ​

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

Defined in: packages/memory/src/kv/lib/local.ts:19

Get the stored value by key. Returns undefined if the key doesn't exist in the store

Type Parameters ​

• T = unknown

Parameters ​

key ​

string

Key to retrieve from the store

Returns ​

Promise<undefined | T>

Stored value, or undefined if key doesn't exist

Implementation of ​

Kv.get

has() ​

has(key): Promise<boolean>

Defined in: packages/memory/src/kv/lib/local.ts:38

Check if a given key exists in the store

Parameters ​

key ​

string

Key to check

Returns ​

Promise<boolean>

Implementation of ​

Kv.has

increment() ​

increment(key, amount): Promise<number>

Defined in: packages/memory/src/kv/lib/local.ts:42

Increment the given stored value by the given amount

Parameters ​

key ​

string

Key to increment in the store

amount ​

number = 1

Amount to increment. Defaults to 1

Returns ​

Promise<number>

Updated value

Implementation of ​

Kv.increment

set() ​

set(key, value): Promise<void>

Defined in: packages/memory/src/kv/lib/local.ts:29

Save the given value to the store

Parameters ​

key ​

string

Key to save in the store

value ​

unknown

Value to save to the store. Can be any JavaScript primitive, plain object, or array

Returns ​

Promise<void>

Implementation of ​

Kv.set

setMax() ​

setMax(key, value): Promise<boolean>

Defined in: packages/memory/src/kv/lib/local.ts:56

Save the given value to the store if the given value is larger than the existing value

Parameters ​

key ​

string

Key to save in the store

value ​

number

Number to save to the store if it's bigger than the current value

Returns ​

Promise<boolean>

Whether or not the given value was saved

Implementation of ​

Kv.setMax