Directus / @directus/memory / index / Kv
Interface: Kv ​
Defined in: packages/memory/src/kv/types/class.ts:1
Methods ​
clear() ​
clear():
Promise<void>
Defined in: packages/memory/src/kv/types/class.ts:53
Remove all keys from the kv store
Returns ​
Promise<void>
delete() ​
delete(
key):Promise<void>
Defined in: packages/memory/src/kv/types/class.ts:23
Remove the given key from the store
Parameters ​
key ​
string
Key to remove from the store
Returns ​
Promise<void>
get() ​
get<
T>(key):Promise<undefined|T>
Defined in: packages/memory/src/kv/types/class.ts:8
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
has() ​
has(
key):Promise<boolean>
Defined in: packages/memory/src/kv/types/class.ts:30
Check if a given key exists in the store
Parameters ​
key ​
string
Key to check
Returns ​
Promise<boolean>
increment() ​
increment(
key,amount?):Promise<number>
Defined in: packages/memory/src/kv/types/class.ts:39
Increment the given stored value by the given amount
Parameters ​
key ​
string
Key to increment in the store
amount? ​
number
Amount to increment. Defaults to 1
Returns ​
Promise<number>
Updated value
set() ​
set<
T>(key,value):Promise<void>
Defined in: packages/memory/src/kv/types/class.ts:16
Save the given value to the store
Type Parameters ​
• T = unknown
Parameters ​
key ​
string
Key to save in the store
value ​
T
Value to save to the store. Can be any JavaScript primitive, plain object, or array
Returns ​
Promise<void>
setMax() ​
setMax(
key,value):Promise<boolean>
Defined in: packages/memory/src/kv/types/class.ts:48
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