Interface StorageProvider

An interface describing a pluggable storage implementation that can be provided to SudoSiteReputationClient as a way to persistently store cache data and user preferences.

interface StorageProvider {
    clear(): Promise<void>;
    clearItem(key: string): Promise<void>;
    getItem(key: string): Promise<undefined | string>;
    keys(): Promise<string[]>;
    setItem(key: string, value: string): Promise<void>;
}

Implemented by

MemoryStorageProvider

Index

Methods

clear clearItem getItem keys setItem

Methods

clear

clear(): Promise<void>
Clears all stored items.

Returns Promise<void>
- Defined in storage-provider.ts:30

clearItem

clearItem(key: string): Promise<void>
Removes an item from storage.
Parameters
- key: string
Returns Promise<void>
- Defined in storage-provider.ts:20

getItem

getItem(key: string): Promise<undefined | string>
Gets an item from storage.
Parameters
- key: string
Returns Promise<undefined | string>
- Defined in storage-provider.ts:10

keys

keys(): Promise<string[]>
Returns keys of all items currently in storage.

Returns Promise<string[]>
- Defined in storage-provider.ts:25

setItem

setItem(key: string, value: string): Promise<void>
Sets an item in storage.
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in storage-provider.ts:15