# real-indexeddb

> IndexedDB for Node.js backed by LMDB (vs fakeIndexedDB which it in RAM only and just for testing)

Latest version **0.0.2** (published 2023-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install real-indexeddb
pnpm add real-indexeddb
yarn add real-indexeddb
bun add real-indexeddb
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-03-25 |
| First published | 2023-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 558.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Simon Y. Blackwell |
| Maintainers | anywhichway |
| Keywords | indexeddb, lmdb, datastore, no-sql, database, transaction |

## Links

- npm: https://www.npmjs.com/package/real-indexeddb
- Repository: https://github.com/anywhichway/realIndexedDB
- Homepage: https://github.com/anywhichway/realIndexedDB#readme
- Issues: https://github.com/anywhichway/realIndexedDB/issues
- npm.io page: https://npm.io/package/real-indexeddb

## Dependencies (1)

- [lmdb](https://npm.io/package/lmdb.md) ^2.7.10

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2023-03-25
- 0.0.1 — 2023-03-24

## README

# realIndexedDB
IndexedDB for Node.js backed by LMDB (vs fakeIndexedDB which it in RAM only and just for testing)

This is ALPHA software. API not yet complete. Unit tests not yet in place.

# Installation

`npm install real-indexeddb`

# Usage

```javascript
import {indexedDB} from "real-indexeddb";

/* standard IndexedDB API Usage */
```

# Implementation Details

IDBObjectStores are LMDB databases inside a master database with a `null` name at the `path` specified with the `indexedB.open(name)` call, where `name` is the path. Indexes are LMDB array keys.

# Status

A database can be created and opened. A value can be put and retrieved. See the file `node_modules/real-indexeddb/examples/kitchen-sink.js` for a working example.

```javascript
import {indexedDB}  from "../index.js";

indexedDB.open("test", 1)
    .withEventListener("success", (event) => {
        const db = event.target.result;
        db.createObjectStore("test")
            .withEventListener("success", (event) => {
                const os = event.target.result;
                os.put("hello", "world")
                    .withEventListener("success", (event) => {
                        os.get("hello")
                            .withEventListener("success", (event) => {
                                console.log(event.target.result);
                                os.delete("hello")
                                    .withEventListener("success", (event) => {
                                        console.log(event.target.result);
                                        os.get("hello")
                                            .withEventListener("success", (event) => {
                                                console.log(event.target.result);
                                            })
                                            .withEventListener(
                                                "error", (event) => {
                                                    console.log(event.target.error);
                                                });
                                    })
                            })
                            .withEventListener(
                                "error", (event) => {
                                    console.log(event.target.error);
                                });
                    })
                    .withEventListener(
                        "error", (event) => {
                            console.log(event.target.error);
                        });
                os.dbi.putSync(true,true);
                os.dbi.putSync(1,1);
                os.dbi.putSync("a","a");
                os.getAllKeys(IDBKeyRange.bound(true,"a",true,true))
                    .withEventListener("success", (event) => {
                        console.log(event.target.result);
                    })
                    .withEventListener("error", (event) => {
                        console.log(event.target.error);
                    })
                os.getAllKeys(IDBKeyRange.bound(true,"a",false,false))
                    .withEventListener("success", (event) => {
                        console.log(event.target.result);
                    })
                    .withEventListener("error", (event) => {
                        console.log(event.target.error);
                    })
                os.getAllKeys(IDBKeyRange.only("a"))
                    .withEventListener("success", (event) => {
                        console.log(event.target.result);
                    })
                    .withEventListener("error", (event) => {
                        console.log(event.target.error);
                    })
                os.getAll(IDBKeyRange.bound(true,"a",false,false))
                    .withEventListener("success", (event) => {
                        console.log(event.target.result);
                    })
                    .withEventListener("error", (event) => {
                        console.log(event.target.error);
                    })
                os.openCursor(IDBKeyRange.bound(true,"a",false,false))
                    .withEventListener("success", (event) => {
                        console.log(event.target.result);
                        const cursor = event.target.result;
                        console.log(cursor.value);
                        cursor.continue();
                        console.log(cursor.value);
                        cursor.continue();
                        console.log(cursor.value);
                    })
                    .withEventListener("error", (event) => {
                        console.log(event.target.error);
                    })
            })
            .withEventListener("error", (event) => {
                console.log(event.target.error);
            })
    }).withEventListener("error", (event) => {
    console.log(event.target.error);
})
```

# Change History (Reverse Chronological Order)

2012-03-25 v0.0.2 Added support for `IDBObjectStore.getAll()`, `IDBObjectStore.getAllKeys()`, and `IDBObjectStore.openCursor()`. Added non-standard `withEventListener` to `IDBRequest` to allow for `addEventListener` to be chained.

2021-03-24 v0.0.1 Initial public release

---
_Source: https://npm.io/package/real-indexeddb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
