[gs-longan](../README.md) / IDB

# Class: IDB

## Table of contents

### Constructors

- [constructor](IDB.md#constructor)

### Properties

- [modelId](IDB.md#modelid)
- [db](IDB.md#db)
- [dbPromise](IDB.md#dbpromise)
- [instance](IDB.md#instance)

### Methods

- [clear](IDB.md#clear)
- [count](IDB.md#count)
- [del](IDB.md#del)
- [get](IDB.md#get)
- [key](IDB.md#key)
- [keys](IDB.md#keys)
- [set](IDB.md#set)
- [transaction](IDB.md#transaction)
- [getInstance](IDB.md#getinstance)

## Constructors

### constructor

• **new IDB**(`modelId`): [`IDB`](IDB.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `modelId` | `any` |

#### Returns

[`IDB`](IDB.md)

## Properties

### modelId

• **modelId**: `any`

___

### db

▪ `Static` **db**: `IDBPDatabase`\<`unknown`\>

___

### dbPromise

▪ `Static` **dbPromise**: `Promise`\<`IDBPDatabase`\<`unknown`\>\>

___

### instance

▪ `Static` **instance**: `Object` = `{}`

## Methods

### clear

▸ **clear**(): `Promise`\<`void`\>

#### Returns

`Promise`\<`void`\>

___

### count

▸ **count**(): `Promise`\<`number`\>

#### Returns

`Promise`\<`number`\>

___

### del

▸ **del**(`key`): `Promise`\<`void`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `any` |

#### Returns

`Promise`\<`void`\>

___

### get

▸ **get**(`key`): `Promise`\<`any`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `any` |

#### Returns

`Promise`\<`any`\>

___

### key

▸ **key**(`key`): `Promise`\<`IDBValidKey`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `any` |

#### Returns

`Promise`\<`IDBValidKey`\>

___

### keys

▸ **keys**(): `Promise`\<`IDBValidKey`[]\>

#### Returns

`Promise`\<`IDBValidKey`[]\>

___

### set

▸ **set**(`key`, `val`): `Promise`\<`IDBValidKey`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `any` |
| `val` | `any` |

#### Returns

`Promise`\<`IDBValidKey`\>

___

### transaction

▸ **transaction**(`mode?`): `Promise`\<`IDBPTransaction`\<`unknown`, [`any`], `IDBTransactionMode`\>\>

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `mode` | `IDBTransactionMode` | `"readonly"` |

#### Returns

`Promise`\<`IDBPTransaction`\<`unknown`, [`any`], `IDBTransactionMode`\>\>

___

### getInstance

▸ **getInstance**(`modelId?`): [`IDB`](IDB.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `modelId?` | `any` |

#### Returns

[`IDB`](IDB.md)