keyvaluestorage
v0.7.1
Published
Isomorphic Key-Value Storage
Downloads
1,451
Maintainers
Readme
keyvaluestorage
Isomorphic Key-Value Storage
Example
import KeyValueStorage from "keyvaluestorage";
const options = {
// required for React-Native platform
// package from @react-native-async-storage/async-storage
asyncStorage: AsyncStorage
// required for NodeJS platform
// sqlite database connection (in-memory supported)
database: 'foobar.db'
// optional for NodeJS platform
// sqlite table name (default: 'keyvaluestorage')
tableName: 'keyvaluestorage'
}
const storage = new KeyValueStorage(options)
// setItem
await storage.setItem('user1', { name: 'John Doe', age: 21 })
// getItem
const item = await storage.getItem('user1')
// removeItem
await storage.removeItem('user1')
API
export class IKeyValueStorage {
public getKeys(): Promise<string[]>;
public getEntries<T = any>(): Promise<[string, T][]>;
public getItem<T = any>(key: string): Promise<T | undefined>;
public setItem<T = any>(key: string, value: T): Promise<void>;
public removeItem(key: string): Promise<void>;
}