Interface LocalStore

Hierarchy

LocalStore

Index

Methods

get has remove removeExpiredKeys set

Methods

get

get(key: string): Promise<unknown>
Get the given value from the store
Parameters
- key: string
  
  The key to the value to retrieve
Returns Promise<unknown>
- Defined in src/types.ts:26

has

has(key: string): Promise<boolean>
Whether the given key is present in the store
Parameters
- key: string
Returns Promise<boolean>
- Defined in src/types.ts:6

remove

remove(key: string): Promise<void>
Remove the given value from the store
Parameters
- key: string
  
  The key to the value to remove
Returns Promise<void>
- Defined in src/types.ts:20

removeExpiredKeys

removeExpiredKeys(): Promise<void>
Returns Promise<void>
- Defined in src/types.ts:28

set

set(key: string, value: unknown, expiration: Date): Promise<void>
Set a value into the store (must be JSON stringifiable)
Parameters
- key: string
- value: unknown
- expiration: Date
  
  The date upon which the value will be expired (and needs to be remove from the store)
Returns Promise<void>
- Defined in src/types.ts:14