Dexie.js ======== [![NPM Version][npm-image]][npm-url] ![Build Status](https://github.com/dexie/Dexie.js/actions/workflows/main.yml/badge.svg) Dexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org #### Why? Dexie solves three main issues with the native IndexedDB API: 1. Ambiguous error handling 2. Poor queries 3. Code complexity Dexie provides a neat database API with a well thought-through API design, robust error handling, extendability, change tracking awareness and extended KeyRange support (case insensitive search, set matches and OR operations). #### Hello World ```html ``` Yes, it's that simple. An equivalent modern version (works in all modern browsers): ```html ``` [Tutorial](https://dexie.org/docs/Tutorial) [API Reference](https://dexie.org/docs/API-Reference) [Samples](https://dexie.org/docs/Samples) ### Performance Dexie has kick-ass performance. Its [bulk methods](https://dexie.org/docs/Table/Table.bulkPut()) take advantage of a lesser-known feature in IndexedDB that makes it possible to store stuff without listening to every onsuccess event. This speeds up the performance to a maximum. #### Supported operations ```js above(key): Collection; aboveOrEqual(key): Collection; add(item, key?): Promise; and(filter: (x) => boolean): Collection; anyOf(keys[]): Collection; anyOfIgnoreCase(keys: string[]): Collection; below(key): Collection; belowOrEqual(key): Collection; between(lower, upper, includeLower?, includeUpper?): Collection; bulkAdd(items: Array): Promise; bulkDelete(keys: Array): Promise; bulkPut(items: Array): Promise; clear(): Promise; count(): Promise; delete(key): Promise; distinct(): Collection; each(callback: (obj) => any): Promise; eachKey(callback: (key) => any): Promise; eachPrimaryKey(callback: (key) => any): Promise; eachUniqueKey(callback: (key) => any): Promise; equals(key): Collection; equalsIgnoreCase(key): Collection; filter(fn: (obj) => boolean): Collection; first(): Promise; get(key): Promise; inAnyRange(ranges): Collection; keys(): Promise; last(): Promise; limit(n: number): Collection; modify(changeCallback: (obj: T, ctx:{value: T}) => void): Promise; modify(changes: { [keyPath: string]: any } ): Promise; noneOf(keys: Array): Collection; notEqual(key): Collection; offset(n: number): Collection; or(indexOrPrimayKey: string): WhereClause; orderBy(index: string): Collection; primaryKeys(): Promise; put(item: T, key?: Key): Promise; reverse(): Collection; sortBy(keyPath: string): Promise; startsWith(key: string): Collection; startsWithAnyOf(prefixes: string[]): Collection; startsWithAnyOfIgnoreCase(prefixes: string[]): Collection; startsWithIgnoreCase(key: string): Collection; toArray(): Promise; toCollection(): Collection; uniqueKeys(): Promise; until(filter: (value) => boolean, includeStopEntry?: boolean): Collection; update(key: Key, changes: { [keyPath: string]: any }): Promise; ``` This is a mix of methods from [WhereClause](https://dexie.org/docs/WhereClause/WhereClause), [Table](https://dexie.org/docs/Table/Table) and [Collection](https://dexie.org/docs/Collection/Collection). Dive into the [API reference](https://dexie.org/docs/API-Reference) to see the details. #### Hello World (Typescript) ```js import Dexie, { Table } from 'dexie'; interface Friend { id?: number; name?: string; age?: number; } // // Declare Database // class FriendDatabase extends Dexie { public friends!: Table; // id is number in this case public constructor() { super("FriendDatabase"); this.version(1).stores({ friends: "++id,name,age" }); } } const db = new FriendDatabase(); db.transaction('rw', db.friends, async() => { // Make sure we have something in DB: if ((await db.friends.where({name: 'Josephine'}).count()) === 0) { const id = await db.friends.add({name: "Josephine", age: 21}); alert (`Addded friend with id ${id}`); } // Query: const youngFriends = await db.friends.where("age").below(25).toArray(); // Show result: alert ("My young friends: " + JSON.stringify(youngFriends)); }).catch(e => { alert(e.stack || e); }); ``` Samples ------- https://dexie.org/docs/Samples https://github.com/dexie/Dexie.js/tree/master/samples Knowledge Base ----- [https://dexie.org/docs/Questions-and-Answers](https://dexie.org/docs/Questions-and-Answers) Website ------- [https://dexie.org](https://dexie.org) Install over npm ---------------- ``` npm install dexie ``` Download -------- For those who don't like package managers, here's the download links: ### Legacy: https://unpkg.com/dexie@latest/dist/dexie.min.js https://unpkg.com/dexie@latest/dist/dexie.min.js.map ### Modern: https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs https://unpkg.com/dexie@latest/dist/modern/dexie.min.mjs.map ### Typings: https://unpkg.com/dexie@latest/dist/dexie.d.ts Contributing ============ See [CONTRIBUTING.md](CONTRIBUTING.md) Build ----- ``` pnpm install pnpm run build ``` Test ---- ``` pnpm test ``` Watch ----- ``` pnpm run watch ```
[![Browser testing via LAMDBATEST](https://dexie.org/assets/images/lambdatest2.png)](https://www.lambdatest.com/) [npm-image]: https://img.shields.io/npm/v/dexie.svg?style=flat [npm-url]: https://npmjs.org/package/dexie

	Stars	Issues	Version	Updated	Created
dexie	10,795	530	4.0.4	23 days ago	10 years ago
lokijs	6,692	29	1.5.12	3 years ago	11 years ago
nedb-promise	95	4	2.0.1	7 years ago	9 years ago
pouchdb	16,295	124	8.0.1	a year ago	12 years ago
tinydb	14	0	0.1.0	10 years ago	10 years ago

dexie vs lokijs vs nedb-promise vs pouchdb vs tinydb

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past