Dexie is a wrapper for IndexedDB, a low-level API for client-side storage of significant amounts of structured data, including files/blobs. Dexie simplifies the use of IndexedDB by providing a more developer-friendly API and additional features such as versioning, transactions, and observability.
Database Initialization
This code initializes a new Dexie database named 'MyDatabase' and defines a schema for a 'friends' table with auto-incrementing primary key 'id' and indexed fields 'name' and 'age'.
const db = new Dexie('MyDatabase');
db.version(1).stores({
friends: '++id,name,age'
});Adding Data
This code adds a new record to the 'friends' table with the name 'John' and age 25.
db.friends.add({name: 'John', age: 25});Querying Data
This code queries the 'friends' table for all records where the age is below 30 and logs the results to the console.
db.friends.where('age').below(30).toArray().then(friends => {
console.log(friends);
});Updating Data
This code updates the record with primary key 1 in the 'friends' table, setting the age to 26.
db.friends.update(1, {age: 26});Deleting Data
This code deletes the record with primary key 1 from the 'friends' table.
db.friends.delete(1);The 'idb' package is a small library that provides a more modern and promise-based API for IndexedDB. It is simpler and lighter than Dexie but does not offer as many advanced features such as observability and complex querying.
LocalForage is a library that provides a simple API for storing data in various storage backends, including IndexedDB, WebSQL, and localStorage. It is more versatile in terms of storage options but does not offer the same level of IndexedDB-specific features and optimizations as Dexie.
PouchDB is a JavaScript database that syncs with CouchDB. It provides a more comprehensive solution for offline-first applications with synchronization capabilities. However, it is heavier and more complex compared to Dexie, which is focused solely on IndexedDB.
Dexie.js is a wrapper library for indexedDB - the standard database in the browser.
Dexie solves three main issues with the native IndexedDB API:
Dexie.js solves these limitations and provides a neat database API. Dexie.js aims to be the first-hand choice of a IDB Wrapper Library due to its well thought-through API design, robust error handling, extendability, change tracking awareness and its extended KeyRange support (case insensitive search, set matches and OR operations).
<html>
<head>
<script src="https://npmcdn.com/dexie/dist/dexie.min.js"></script>
<script>
//
// Declare Database
//
var db = new Dexie("FriendDatabase");
db.version(1).stores({ friends: "++id,name,age" });
//
// Manipulate and Query Database
//
db.friends.add({name: "Josephine", age: 21}).then(function() {
return db.friends.where("age").below(25).toArray();
}).then(function (youngFriends) {
alert ("My young friends: " + JSON.stringify(youngFriends));
}).catch(function (e) {
alert ("Error: " + e.stack || e);
});
</script>
</head>
</html>
import Dexie from 'dexie';
//
// Declare Database
//
var db = new Dexie("FriendDatabase");
db.version(1).stores({ friends: "++id,name,age" });
//
// Manipulate and Query Database
//
Dexie.spawn(function*(){
// Dexie.spawn gives you the possibility to use yield.
// Use yield like async works in Typescript / ES7
// Add to database
yield db.friends.add({name: "Josephine", age: 21});
// Query database
let youngFriends = yield db.friends.where("age").below(25).toArray();
alert ("My young friends: " + JSON.stringify(youngFriends));
}).catch(e => {
alert("error: " + e.stack || e);
});
Here's the simples typescript sample from Dexie.js/samples/typescript-simple:
import Dexie from 'dexie';
interface IFriend {
id?: number;
name?: string;
age?: number;
}
//
// Declare Database
//
class FriendDatabase extends Dexie {
friends: Dexie.Table<IFriend,number>;
constructor() {
super("FriendsDatabase");
this.version(1).stores({
friends: "++id,name,age"
});
}
}
var db = new FriendDatabase();
//
// Manipulate and Query Database
//
db.friends.add({name: "Josephine", age: 21}).then(()=>{
return db.friends.where("age").below(25).toArray();
}).then(youngFriends => {
alert ("My young friends: " + JSON.stringify(youngFriends));
}).catch(e => {
alert("error: " + e.stack || e);
});
To see this in action, clone Dexie and cd to samples/typescript-simple. Then type:
npm install
npm run build
num run start
... and launch web browser to http://localhost:8081
https://github.com/dfahlander/Dexie.js/wiki/Dexie.js
https://github.com/dfahlander/Dexie.js/wiki/Samples
https://github.com/dfahlander/Dexie.js/tree/master/samples
https://groups.google.com/forum/#!forum/dexiejs
npm install dexie
For those who don't like package managers, here's the download links:
https://npmcdn.com/dexie/dist/dexie.min.js
https://npmcdn.com/dexie/dist/dexie.min.js.map
https://npmcdn.com/dexie/dist/dexie.d.ts
Here is a little cheat-sheet for how to symlink your app's node_modules/dexie to a place where you can edit the source, version control your changes and create pull requests back to Dexie. Assuming you've already ran npm install dexie --save for the app your are developing.
Fork Dexie.js from the web gui on github
Clone your fork locally by launching a shell/command window and cd to a neutral place (like ~repos/, c:\repos or whatever) and type:
git clone https://github.com/YOUR-USERNAME/Dexie.js.git
cd Dexie.js
npm install
npm run build
npm link
cd to your app directory and write:
npm link dexie
Your app's node_modules/dexie/ is now sym-linked to the Dexie.js clone on your hard drive so any change you do there will propagate to your app. Build dexie.js using npm run build or npm run watch. The latter will react on any source file change and rebuild the dist files.
That's it. Now you're up and running to test and commit changes to Dexie.js that will instantly affect the app you are developing.
Pull requests are more than welcome. Some advices are:
test/tests-misc.js. We use qunit. Just look at existing tests in tests-misc.js to see how they should be written. Tests are transpiled in the build script so you can use ES6 if you like.npm run build
npm test
npm run watch
FAQs
A Minimalistic Wrapper for IndexedDB
The npm package dexie receives a total of 363,199 weekly downloads. As such, dexie popularity was classified as popular.
We found that dexie demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.