neo-idb

A small, typed wrapper around IndexedDB with Promise-based API and versioned migrations.

Install

npm install neo-idb

Quick Start

import { neoIDB } from 'neo-idb'

type AppSchema = {
  stores: {
    pets: {
      keyPath: 'id'
      value: { id: number; name: string; type?: 'cat' | 'dog' }
      indexes: {
        byType: { keyPath: 'type' }
      }
    }
  }
}

const db = await neoIDB<AppSchema>({
  name: 'my-app-db',
  definition: (v) => {
    v(1).addStore('pets', 'id').addIndex('pets', 'byType', 'type')
  },
})

await db.add('pets', { id: 1, name: 'Milo', type: 'cat' })
const pet = await db.get('pets', 1)
const cats = await db.index('pets', 'byType', (index) => index.getAll('cat'))

Main Methods

• db.add, db.addMany, db.put, db.delete, db.deleteMany, db.clear
• db.get, db.getAll, db.getAllKeys, db.getKey, db.count
• db.index(store, index, callback)
• db.tx(stores, mode, callback)

Development

npm run test
npm run typecheck
npm run build

License

MIT