Class: IDBHelper

Constructors

new IDBHelper()

new IDBHelper(name: string): IDBHelper

构造函数

Parameters

Parameter	Type	Description
name	string	数据库名称

Returns

IDBHelper

IDBHelper实例

---

Throws

Error 数据库名称不能为空

Methods

close()

close(): Promise<undefined | false>

关闭数据库

Example

const db = new IDBHelper('test');
await db.close();

Returns

Promise<undefined | false>

---

---

createTable()

createTable(tableNameList: string | string[], keyPath?: string): Promise<boolean>

创建表

Example

const db = new IDBHelper('test');
await db.createTable('tn');

Parameters

Parameter	Type	Description
tableNameList	string | string[]	表名列表
keyPath?	string	主键

Returns

Promise<boolean>

---

---

deleteAllTable()

deleteAllTable(): Promise<boolean>

删除所有表

Example

const db = new IDBHelper('test');
await db.deleteAllTable();

Returns

Promise<boolean>

---

---

deleteTable()

deleteTable(tableNameList: string | string[]): Promise<boolean>

删除表

Example

const db = new IDBHelper('test');
await db.deleteTable('tn');

Parameters

Parameter	Type	Description
tableNameList	string | string[]	表名列表

Returns

Promise<boolean>

---

---

deleteTableRow()

deleteTableRow(tableName: string, key: string): Promise<undefined | false>

删除表中某行数据

Example

const db = new IDBHelper('test');
await db.deleteTableRow('tn', 'key');

Parameters

Parameter	Type	Description
tableName	string	表名
key	string	键

Returns

Promise<undefined | false>

---

---

getAllTableName()

getAllTableName(): Promise<false | DOMStringList>

获取所有表名

Example

const db = new IDBHelper('test');
await db.getAllTableName();

Returns

Promise<false | DOMStringList>

false 或 string[]

---

---

getAllTableRow()

getAllTableRow(tableName: string, range?: IDBKeyRange): Promise<unknown>

获取表中所有数据

Example

const db = new IDBHelper('test');
await db.getAllTableRow('tn');

Parameters

Parameter	Type	Description
tableName	string	表名
range?	IDBKeyRange	范围

Returns

Promise<unknown>

---

---

getTableRow()

getTableRow(tableName: string, key: string): Promise<unknown>

获取表中某行数据

Example

const db = new IDBHelper('test');
await db.getTableRow('tn', 'key');

Parameters

Parameter	Type	Description
tableName	string	表名
key	string	键

Returns

Promise<unknown>

---

---

getTableRowCount()

getTableRowCount(tableName: string, range?: IDBKeyRange): Promise<unknown>

获取表数据条数

Example

const db = new IDBHelper('test');
await db.getTableRowCount('tn');

Parameters

Parameter	Type	Description
tableName	string	表名
range?	IDBKeyRange	范围

Returns

Promise<unknown>

---

---

reSet()

reSet(): Promise<false | Boolean>

重置数据库

Example

const db = new IDBHelper('test');
await db.reSet();

Returns

Promise<false | Boolean>

---

---

setTableRow()

setTableRow(tableName: string, data: any): Promise<undefined | false>

增加/修改表中某行数据

Example

const db = new IDBHelper('test');
await db.setTableRow('tn', '你好！');

Parameters

Parameter	Type	Description
tableName	string	表名
data	any	数据

Returns

Promise<undefined | false>

---