Directus / @directus/memory / index / Kv
Interface: Kv ​
Methods ​
clear() ​
clear():
Promise<void>
Remove all keys from the kv store
Returns ​
Promise<void>
Defined in ​
packages/memory/src/kv/types/class.ts:53
delete() ​
delete(
key):Promise<void>
Remove the given key from the store
Parameters ​
• key: string
Key to remove from the store
Returns ​
Promise<void>
Defined in ​
packages/memory/src/kv/types/class.ts:23
get() ​
get<
T>(key):Promise<undefined|T>
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
Defined in ​
packages/memory/src/kv/types/class.ts:8
has() ​
has(
key):Promise<boolean>
Check if a given key exists in the store
Parameters ​
• key: string
Key to check
Returns ​
Promise<boolean>
Defined in ​
packages/memory/src/kv/types/class.ts:30
increment() ​
increment(
key,amount?):Promise<number>
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
Defined in ​
packages/memory/src/kv/types/class.ts:39
set() ​
set<
T>(key,value):Promise<void>
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>
Defined in ​
packages/memory/src/kv/types/class.ts:16
setMax() ​
setMax(
key,value):Promise<boolean>
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