Dexie.js is a minimalistic, high-performance wrapper for IndexedDB — the standard database in every browser. It's used by applications like WhatsApp Web, ChatGPT, GitHub Desktop, and many more.
🤖 AI/LLM? For a structured documentation summary optimized for AI assistants, see llms.txt.
Getting Started
New to Dexie? Start here:
- Getting Started Tutorial — Build your first Dexie app in minutes
- Hello World — Minimal example to get running
- React Tutorial — Using Dexie with React and hooks
- Vue Tutorial — Using Dexie with Vue.js
- Angular Tutorial — Using Dexie with Angular
- Svelte Tutorial — Using Dexie with Svelte
Core Documentation
Dexie.js (Local Database)
- API Reference — Complete API documentation
- Quick Reference — Cheat sheet for common operations
- About Dexie.js — Overview, features, and known users
- Best Practices — Patterns and recommendations
- Samples — Example applications and code
Dexie Cloud (Sync & Collaboration)
Dexie Cloud adds sync, authentication, access control, and real-time collaboration to your Dexie app:
- Dexie Cloud Overview — What Dexie Cloud offers
- Getting Started with Dexie Cloud — Add sync to your app
- Quickstart — Fastest path to a syncing app
- Best Practices — Including primary keys
- Authentication — Login, OAuth, OTP
- Access Control — Realms, roles, permissions
- Consistency Models — Server-authoritative and CRDT
- Y.js Integration — Real-time collaborative editing
Reference
- Table API — add(), put(), get(), where(), etc.
- Collection API — Filtering, sorting, iterating
- WhereClause API — Query operators
- Transaction API — Atomic operations
- Dexie Class — Database instance methods
- Error Types — Understanding Dexie errors
Additional Resources
- TypeScript Guide — Type-safe database access
- Questions & Answers — Common questions answered
- Addons & Derived Work — Community extensions
- Deprecations — Breaking changes and migrations
Community & Support
- Stack Overflow — Ask questions (fastest response)
- GitHub Issues — Bug reports and feature requests
- Discord — Community chat
- GitHub Repository — Source code (14k+ stars)
📦 Download / Install — npm, CDN, and direct download options