ImmortalDB
ImmortalDB is the best way to store persistent key-value data in the browser. Data saved to ImmortalDB is redundantly stored in Cookies, IndexedDB, and LocalStorage, and relentlessly self heals if any data therein is deleted or corrupted.
For example, clearing cookies is a common user action, even for non-technical users. And browsers unceremoniously delete IndexedDB, LocalStorage, and/or SessionStorage without warning under storage pressure.
ImmortalDB is resilient in the face of such events.
In this way, ImmortalDB is like Evercookie, but
Is actively maintained and well documented.
Provides a simple, modern, Promise-based API.
Strikes an equitable balance between reliability and respect for the user. Data is stored reliably but can also be voluntarily purged if the user designedly clears cookies and application storage.
Doesn't use nefarious exploits nor deprecated third party plugins like Flash, Silverlight, or Java. Only standard, ratified HTML5 APIs are used.
Doesn't vandalize performance or the user experience. For example, Evercookie's CSS History Knocking can beget a deluge of background HTTP requests, and loading Silverlight or Flash can raise unsought permission modals or thrash the user's disk.
When you store a key-value pair in ImmortalDB, that key and value are saved redundantly in the browser's cookies, IndexedDB, and LocalStorage data stores.
When a value is retrieved via its key, ImmortalDB
Then ImmortalDB self-heals: if any data store(s) returned a value different than the determined correct value, or no value at all, the correct value is rewritten to that store. In this way, consensus, reliability, and redundancy is maintained.
ImmortalDB's API is simple. To store a value, use set(key, value)
:
import { ImmortalDB } from 'immortal-db'
await ImmortalDB.set('key', 'value')
key
and value
must be
DOMStrings.
ImmortalDB.set(key, value)
also always returns value
, so it can be chained or
embedded, like
const countPlusOne = (await ImmortalDB.set('count', numberOfClowns)) + 1
To retrieve a value, use get(key, default=null)
:
const value = await ImmortalDB.get('key', default=null)
get()
returns the value associated with key
, if key
exists. If key
doesn't exist, default
is returned. key
must be a
DOMString.
Finally, to remove a key, use remove(key)
:
ImmortalDB.set('hi', 'bonjour')
console.log(await ImmortalDB.get('hi')) // Prints 'bonjour'.
await ImmortalDB.remove('hi')
console.log(await ImmortalDB.get('hi')) // Prints 'null'.
key
must be a
DOMString.
The data stores that ImmortalDB stores data in can also be configured. For example, this is how to store data reliably in cookies and LocalStorage only:
import { ImmortalStorage, CookieStore, LocalStorageStore } from 'immortal-db'
const stores = [await CookieStore(), await LocalStorageStore()]
const db = new ImmortalStorage(stores)
await db.set(key, JSON.stringify({1:1}))
By default, stores used by ImmortalDB
are:
CookieStore
-> Keys and values are stored in document.cookie
.IndexedDbStore
-> Keys and values are stored in window.indexedDB
.LocalStorageStore
-> Keys and values are stored in window.localStorage
.Other, optional stores are:
SessionStorageStore
-> Keys and values are stored in window.sessionStorage
.New storage implementations can easily be added, too; they need only
implement the async methods get(key, default)
, set(key, value)
, and
remove(key)
.
Installing ImmortalDB with npm is easy.
$ npm install immortal-db
Or include dist/immortal-db[.min].js
and use window.ImmortalDB
directly.
<html>
<head>
<script src="immortal-db.min.js"></script>
<script>
;(async () => {
const db = ImmortalDB.ImmortalDB
await db.set('hi', 'lolsup')
})()
</script>
</head>
...
</html>
To test ImmortalDB, run
npm run start
This starts a webpack dev server and opens ImmortalDB's testing website, http://localhost:9234/.
Once tested, to produce new production-ready files immortal-db.js
and
immortal-db.min.js
in dist/
, run
npm run build
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型