Class IDB

Hierarchy

IDB

Index

Accessors

objectStores

Methods

delete
init

Accessors

objectStores

get objectStores(): ObjectStoresAndActionMap

- Defined in IDB.ts:130
Retrieves data base object stores and methods map

Returns ObjectStoresAndActionMap

An map containing defined object stores, and methods to perform action on object stores

Access object stores :
```
const { Todo } = DB.objectStores;
```
Iterate over data base object stores :
```
await DataBase.objectStores.methods.iterate((objectStore) => { /\* Some async operation *\/ })
```

Methods

delete

delete(): Promise<void>

- Defined in IDB.ts:172
Delete an indexed database
```
await DataBase.delete("task one")
```
Returns Promise<void>

Static init

init(dataBaseName: string, dataBaseVersion: number, objectStores: ObjectStoreInitializer | ObjectStoreInitializer[] | ObjectStoreInitializerFunction): IDB

- Defined in IDB.ts:71
Initialize an indexed data base

Parameters
- dataBaseName: string
  
  Data base name
- dataBaseVersion: number
  
  Data base Version
- objectStores: ObjectStoreInitializer | ObjectStoreInitializer[] | ObjectStoreInitializerFunction
  
  Initialize objectStore(s)
Returns IDB

An indexed data base that contains defined object store

Creating single object Store :
```
const DB = IDB.init("TodoDataBase", 1, { name: "Todo", options: { keyPath: "id" } });
```
Create multiple object Stores :
```
const DB = IDB.init("TodoDataBase", 1, [ { name: "Todo" }, {name: "Notes", options: { keyPath: "id" }} ]);
```
Use a callback function to initialize object stores :
```
const DB = IDB.init("TodoDataBase", 1, () => {
 return { name: "Todo", options: { autoIncrement: true } };
 // or returns objectStores list:
 return [ { name: "Todo" }, { name: "Note" } ]
});
```

Generated using TypeDoc