# r-indexdb

**Repository Path**: rasir/r-indexdb

## Basic Information

- **Project Name**: r-indexdb
- **Description**: indexdb查询工具
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-12-07
- **Last Updated**: 2022-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# indexDb 增删改查工具

### 快速上手

使用 npm 包

```
npm i r-indexdb -S
```

在函数中使用

```
import RIndexDb from 'r-indexdb';
const dbInst = new RIndexDb('dbName',[{name:'tbName',keyPath:'id'}])

async function findById(id){
    await dbInst.ready();
    const ret = await dbInst.findByPk('tbName',id);
    return ret;
}
```

### 使用方式

在使用该工具进行增删改查之前，需要先调用 `await dbInst.ready()`方法等待初始化完毕。

### API

#### 获取实例

```
const dbInst = new RIndexDb(databaseName: string,tbConfigs?: TbConfig[], dbVersion?: number,);

databaseName // 新建或者打开的库名
dbVersion // 库版本号默认为 1
tbConfigs // 库中需要使用的表的配置。

interface TbConfig {
    name: string; // 表名
    autoIncrement?: boolean; // 是否自增主键
    keyPath?: string; // 主键字段
    indexs?: IndexConfig[]; // 表索引配置
}

interface IndexConfig {
    name: string; // 索引名，不能重复
    prop: string; // 在存储对象上的那个属性上建立索引，可以是一个单个的key值，也可以是一个包含key值集合的数组
    config?: {
        unique: boolean; // 用来指定索引值是否可以重复，为true代表不能相同，为false时代表可以相同
        multiEntry: boolean; // 当第二个参数keyPath为一个数组时，如果multiEntry是true，则会以数组中的每个元素建立一条索引，如果是false，则以整个数组为keyPath值，添加一条索引
}
```

#### 新增数据

1、单条新增数据`create`。
`create(tbName: string, data: any): Promise<unknown>;`
2、批量新增数据`bulkCreate`。
`bulkCreate(tbName: string, datas: any[]): Promise<unknown>;`
3、通过主键查找数据`findByPk`。
`findByPk(tbName: string, keyPath: string): Promise<unknown>;`
4、通过索引查找数据`findByIndex`。
`findByIndex(tbName: string, indexName: string, keyPath: string): Promise<unknown>;`
5、通过函数过滤查找数据`query`。
`query(tbName: string, filter?: (item: any) => boolean): Promise<unknown>;`
6、通过主键来更新数据`update`。
`update(tbName: string, data: any): Promise<unknown>;`
7、通过主键删除数据`delete`。
`delete(tbName: string, keyPath: string): Promise<unknown>;`
8、如果无法通过主键来更新和删除数据，可以使用 `forEach`来`cursor`进行操作。
`forEach(tbName: string, callback: (cursor: any) => void): Promise<unknown>;`

```
使用cursor.value拿到数据.
使用cursor.updata()更新数据.
使用cursor.delete()删除数据.
使用cursor.continue()读取下一条数据.
```

9、新增表`createStore`
`createStore(tbName: string, tconfig?: Omit<TbConfig, "name">): IDBObjectStore | undefined;`
10、新增索引`createIndex`。
`createIndex(tb: string | IDBObjectStore | undefined, index: IndexConfig): boolean;`
11、删除表中所有数`dropStore`。
`dropStore(tbName: string): Promise<unknown>;`