@whitesev/utils
Version:
一个常用的工具库
133 lines (132 loc) • 3.8 kB
TypeScript
declare class indexedDB {
#private;
/**
* @param dbName 数据存储名，默认为：default_db
* @param storeName 表名，默认为：default_form
* @param dbVersion indexDB的版本号，默认为：1
*/
constructor(dbName?: string, storeName?: string, dbVersion?: number);
/**
* 创建 “表”
* @param dbName 表名
*/
createStore(dbName: string): IDBObjectStore;
/**
* 打开数据库
* @param callback 回调
* @param dbName 数据库名
*/
private open;
/**
* 保存数据到数据库
* @param key 数据key
* @param value 数据值
*/
save<T extends any>(key: string, value: T): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest<T>;
target: IDBRequest<T>;
} & Event;
}>;
/**
* 判断是否存在该数据
* @param key 数据key
*/
has(key: string): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest;
target: IDBRequest;
} & Event;
}>;
/**
* 根据key获取值
* @param key 数据key
*/
get<T extends any>(key: string): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 获取的数据 */
data: T;
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest<T>;
target: IDBRequest<T>;
} & Event;
/** 获取的结果，里面的数据提取为data */
result?: {
key: string;
value: T;
};
}>;
/**
* 正则获取数据
* @param key 数据key，可以是正则
*/
regexpGet<T extends any>(key: string | RegExp): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 获取到的数据列表 */
data: T[];
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest<T>;
target: IDBRequest<T>;
} & Event;
}>;
/**
* 删除数据
* @param key 数据key
*/
delete(key: string): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest;
target: IDBRequest;
} & Event;
}>;
/**
* 删除所有数据
*/
deleteAll(): Promise<{
/** 本操作是否成功 */
success: boolean;
/** 状态码 */
code: number;
/** 状态码对应的消息 */
msg: string;
/** 执行操作触发的事件，如果是在open阶段失败的话该值为空 */
event?: {
srcElement: IDBRequest;
target: IDBRequest;
} & Event;
}>;
}
export { indexedDB };