Dexie Immutable Addon
This addon can be used as a stand-alone addon for Dexie.js, yet is also part of dexie-addon-suite 
Install over npm
npm install @pvermeer/dexie-immutable-addon
Dexie.js
Dexie Immutable Addon depends on Dexie.js v3.
npm install dexie
Documentation
How to use
Addon
Add immutable() to your Dexie database. See below examples and https://dexie.org for more info.
This addon just overwrites the save methods of Dexie.js and uses the lodash cloneDeep method before saving records to IndexedDb. This prevents the original input object to be modified by Dexie.
For example: an ++id in your Table schema and using add() mutates the input object to { id: <some number>, ...originalObject }, while bulkAdd() does not mutate the input objects. In combination with other addons, that mutate input (e.g.: encryption), this could lead to some weird and unexpected behavior.
Create Dexie database
ESM
import Dexie from "dexie";
import { immutable } from "@pvermeer/dexie-immutable-addon";
// Declare Database
const db = new Dexie("FriendDatabase", {
addons: [immutable],
});
db.version(1).stores({
friends: "++id, firstName, lastName, shoeSize, age",
});
// Open the database
db.open().then(() => {
console.log("DB loaded! :D");
// Use Dexie
});Typescript
import Dexie from "dexie";
import { immutable } from "@pvermeer/dexie-immutable-addon";
// Declare Database
class FriendsDatabase extends Dexie {
public friends: Dexie.Table<Friend, number>;
constructor(name: string) {
super(name);
immutable(this);
this.version(1).stores({
friends: "++id, firstName, lastName, shoeSize, age",
});
}
}
const db = new FriendDatabase("FriendsDatabase");
// Open the database
db.open().then(() => {
console.log("DB loaded! :D");
// Use Dexie
});HTML import
Bundled & minified package: https://unpkg.com/@pvermeer/dexie-immutable-addon@latest/dist/dexie-immutable-addon.min.js.
Addon is export as namespace DexieImmutableAddon
<!DOCTYPE html>
<html>
<head>
<!-- Include Dexie (@next if v3 is still in RC) -->
<script src="https://unpkg.com/dexie@latest/dist/dexie.js"></script>
<!-- Include DexieImmutableAddon (always after Dexie, it's a dependency) -->
<script src="https://unpkg.com/@pvermeer/dexie-immutable-addon@latest/dist/dexie-immutable-addon.min.js"></script>
<script>
// Define your database
const db = new Dexie("FriendDatabase", {
addons: [DexieImmutableAddon.immutable],
});
db.version(1).stores({
friends: "++id, firstName, lastName, shoeSize, age",
});
// Open the database
db.open().then(() => {
console.log("DB loaded! :D");
// Do Dexie stuff
});
</script>
</head>
</html>API
The packet exposes one export:
immutable - addon function
function immutable(db: Dexie): void;Dexie.js
Dexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org