indexdb-storage
v0.1.1
Published
use indexdb like localstorage
Downloads
41
Readme
indexdb-storage
旨在 提供 类似 localstorage 方法的 indexDB 操作
兼容
ie >= 10
安装
# yarn
yarn add indexdb-storage
# npm
npm i indexdb-storage --save
使用
import { IndexDBStorage } from 'indexdb-storage'
const dbStorage = new IndexDBStorage({
name: 'testdb'
})
// 数据设置
dbStorage.setItem('hello', {
a: 1,
b: {
c: 2
}
})
// 数据获取
dbStorage.getItem('hello').then((d) => {
console.log(d)
})
// 数据清除
dbStorage.clean()
types
/** IndexDBStorage - option */
export interface IndexDBStorageOption {
/** 数据库名称 */
name?: string
/** 数据库版本 */
version?: number
/** logger */
logger?: (type: LogType, args: any[]) => void
}
export declare enum LogType {
Success = 'success',
Warn = 'warn',
Error = 'error',
Info = 'info'
}
/** IndexDBStorage - 属性 */
export declare type IndexDBStorageProperty = Required<IndexDBStorageOption>
/** IndexDBStorage - 主体 */
export declare class IndexDBStorage {
name: IndexDBStorageProperty['name']
storeName: string
version: IndexDBStorageProperty['version']
isSupported: boolean
private logger
constructor(option?: IndexDBStorageOption)
private log
/** 清除 db */
clear(): void
/** 打开db */
open(): Promise<IDBDatabase | undefined>
/** 设置 */
setItem<V = any>(name: string, value: V): Promise<string | undefined>
/** 获取 */
getItem<V = any>(name: string): Promise<V | undefined>
}