Dexie.js ======== [![NPM Version][npm-image]][npm-url] [![Build Status](https://travis-ci.org/dfahlander/Dexie.js.svg?branch=master)](https://travis-ci.org/dfahlander/Dexie.js)[![Tested with Browserstack](http://dexie.org/assets/images/tested-with-browserstack2.png)](https://www.browserstack.com) Dexie.js is a wrapper library for indexedDB - the standard database in the browser. http://dexie.org #### Why? Dexie solves three main issues with the native IndexedDB API: 1. Ambivalent 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. [Tutorial](http://dexie.org/docs/Tutorial) [API Reference](http://dexie.org/docs/API-Reference) [Samples](http://dexie.org/docs/Samples) ### Performance Dexie has a kick-ass performance. It's [bulk methods](http://dexie.org/docs/Table/Table.bulkPut()) take advantage of a not well 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](http://dexie.org/docs/WhereClause/WhereClause), [Table](http://dexie.org/docs/Table/Table) and [Collection](http://dexie.org/docs/Collection/Collection). Dive into the [API reference](http://dexie.org/docs/API-Reference) to see the details. #### Hello World (ES2016 / ES7) ```js import Dexie from 'dexie'; // // Declare Database // var db = new Dexie("FriendDatabase"); db.version(1).stores({ friends: "++id,name,age" }); db.transaction('rw', db.friends, async() => { // Make sure we have something in DB: if ((await db.friends.where('name').equals('Josephine').count()) === 0) { let id = await db.friends.add({name: "Josephine", age: 21}); alert (`Addded friend with id ${id}`); } // Query: let youngFriends = await db.friends.where("age").below(25).toArray(); // Show result: alert ("My young friends: " + JSON.stringify(youngFriends)); }).catch(e => { alert(e.stack || e); }); ``` #### Hello World (Typescript) *This sample requires using Dexie v2* ```js import Dexie from 'dexie'; interface IFriend { id?: number; name?: string; age?: number; } // // Declare Database // class FriendDatabase extends Dexie { friends: Dexie.Table