Create a CryptedIndexedDBAdapter.
Optional options: Partial<CryptedIndexedDBAdapterOptions>Configuration options for the adapter
Private #secretChanges the password of a database and re-encrypts the database with the new password.
CryptedIndexedDBAdapter
A promise that resolves when the password has been changed.
If the adapter is not open.
await adapter.changePassword("mydb", "newpassword");
// The database "mydb" is now encrypted with the password "newpassword".
// The old password will no longer work.
The new password to encrypt the database with.
Deletes a serialized db from the catalog.
// DELETE DATABASE
// delete 'finance'/'test' value from catalog
idbAdapter.deleteDatabase('test', function {
// database deleted
});
SylvieIndexedAdapter
the name of the database to delete from the catalog.
Optional callback: PersistenceAdapterCallback(Optional) executed on database delete
Removes all database partitions and pages with the base filename passed in. This utility method does not (yet) guarantee async deletions will be completed before returning
SylvieIndexedAdapter
the base filename which container, partitions, or pages are derived
Retrieves object array of catalog entries for current app.
idbAdapter.getDatabaseList(function(result) {
// result is array of string names for that appcontext ('finance')
result.forEach(function(str) {
console.log(str);
});
});
SylvieIndexedAdapter
should accept array of database names in the catalog for current app.
Retrieves a serialized db string from the catalog.
// LOAD
var idbAdapter = new SylvieIndexedAdapter('finance');
var db = new loki('test', { adapter: idbAdapter });
db.loadDatabase(function(result) {
console.log('done');
});
the name of the database to retrieve.
callback should accept string param containing serialized db string.
Retrieves a serialized db string from the catalog, returns a promise to a string of the serialized database.
A promise to a string of the serialized database.
const db = new Sylvie(TEST_DB_NAME, {
adapter: new CryptedIndexedDBAdapter();
});
await db.loadDatabaseAsync({});
// db is now ready to use
// you can also chain the promises
await db.loadDatabaseAsync({}).then(() => {
// db is now ready to use
});
// or use async await syntax
await db.loadDatabaseAsync({});
// db is now ready to use
CryptedIndexedDBAdapter
If the database is not found.
If the database is not decrypted successfully.
If the database is not deserialized successfully.
Saves a serialized db to the catalog.
// SAVE : will save App/Key/Val as 'finance'/'test'/{serializedDb}
var idbAdapter = new SylvieIndexedAdapter('finance');
var db = new loki('test', { adapter: idbAdapter });
var coll = db.addCollection('testColl');
coll.insert({test: 'val'});
db.saveDatabase(); // could pass callback if needed for async complete
the name to give the serialized database within the catalog.
the serialized db string to save.
Optional callback: PersistenceAdapterCallback(Optional) callback passed obj.success with true or false
Sets a password for use on future load and save of the database. Note that this does not re-encrypt the database with the new password. Use changePassword() for that.
const db = new Sylvie(TEST_DB_NAME, {
adapter: new CryptedIndexedDBAdapter();
});
adapter.usePassword("newpassword");
await newDb.loadDatabaseAsync({});
Generated using TypeDoc
Loki/Sylvie encrypted persistence adapter class for indexedDb. This class fulfills abstract adapter interface which can be applied to other storage methods. Utilizes the included SylvieCatalog app/key/value database for actual database persistence. IndexedDb storage is provided per-domain, so we implement app/key/value database to allow separate contexts for separate apps within a domain.
Example