@easylib.ts/idb
v1.0.0
Published
Typescript wrapper for IndexDB
Readme
easyidb.ts
A tiny TypeScript wrapper around the browser IndexedDB API. Provides a small, typed interface for opening a database and working with simple object stores using promise-based helpers.
Features
- Minimal, zero-dependency wrapper for IndexedDB
- Typed API using TypeScript generics
- Promise-based
set,get,getAll,deletehelpers
Install
npm install easyidb.tsQuick Usage
Example TypeScript usage:
import { openDB } from 'easyidb.ts';
type MyDB = {
users: { id: number; name: string };
};
const db = openDB<MyDB>('my-db', ['users']);
const users = db.openTable('users');
await users.set(1, { id: 1, name: 'Alice' });
const alice = await users.get(1);
const all = await users.getAll();API
openDB<DB>(name, tables, version?)— create/open a typed databasedb.openTable(name)— return aTable<T>wrapper for a named tableTable<T>.set(key, value)— store a valueTable<T>.get(key)— read a value orundefinedTable<T>.getAll()— read all valuesTable<T>.delete(key)— delete a value
License
MIT — see the LICENSE file for details.
