@buley/dash 0.0.30 → 2.1.4

package/dist/indexes/index.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.indexesMethods = void 0;
-/**
- * Indexes methods
- * @module indexes
- */
-var utilities_1 = require("../utilities");
-// Indexes methods
-exports.indexesMethods = {
-    /**
-     * Get all indexes from a specific object store.
-     * @param get_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    get: function (get_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a;
-            try {
-                get_ctx.indexes = (_a = get_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.indexNames;
-                if (get_ctx.on_success) {
-                    (0, utilities_1.safeApply)(get_ctx.on_success, [get_ctx]);
-                }
-                resolve(get_ctx);
-            }
-            catch (error) {
-                get_ctx.error = (0, utilities_1.cloneError)(error);
-                if (get_ctx.on_error) {
-                    (0, utilities_1.safeApply)(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-            }
-        });
-    },
-    /**
-     * Add a new index to an object store.
-     * @param add_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    add: function (add_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a;
-            try {
-                (_a = add_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.createIndex(add_ctx.index, add_ctx.index_key_path, {
-                    unique: !!add_ctx.index_unique,
-                    multiEntry: !!add_ctx.index_multi_entry
-                });
-                if (add_ctx.on_success) {
-                    (0, utilities_1.safeApply)(add_ctx.on_success, [add_ctx]);
-                }
-                resolve(add_ctx);
-            }
-            catch (error) {
-                add_ctx.error = (0, utilities_1.cloneError)(error);
-                if (add_ctx.on_error) {
-                    (0, utilities_1.safeApply)(add_ctx.on_error, [add_ctx]);
-                }
-                reject(add_ctx);
-            }
-        });
-    },
-    /**
-     * Remove an index from an object store.
-     * @param remove_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    remove: function (remove_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a;
-            try {
-                (_a = remove_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.deleteIndex(remove_ctx.index);
-                if (remove_ctx.on_success) {
-                    (0, utilities_1.safeApply)(remove_ctx.on_success, [remove_ctx]);
-                }
-                resolve(remove_ctx);
-            }
-            catch (error) {
-                remove_ctx.error = (0, utilities_1.cloneError)(error);
-                if (remove_ctx.on_error) {
-                    (0, utilities_1.safeApply)(remove_ctx.on_error, [remove_ctx]);
-                }
-                reject(remove_ctx);
-            }
-        });
-    },
-    /**
- * Get all entries from a specific index.
- * @param get_ctx The context object.
- * @returns Promise<DashContext>
- */
-    getEntries: function (get_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a, _b;
-            var request = (_b = (_a = get_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.index(get_ctx.index)) === null || _b === void 0 ? void 0 : _b.openCursor();
-            if (!request) {
-                get_ctx.error = new Error("Failed to open cursor");
-                if (get_ctx.on_error) {
-                    (0, utilities_1.safeApply)(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-                return;
-            }
-            request.onsuccess = function (event) {
-                var cursor = request.result;
-                if (cursor) {
-                    if (get_ctx.on_success) {
-                        (0, utilities_1.safeApply)(get_ctx.on_success, [cursor.value]);
-                    }
-                    cursor.continue();
-                }
-                else {
-                    if (get_ctx.on_complete) {
-                        (0, utilities_1.safeApply)(get_ctx.on_complete, [get_ctx]);
-                    }
-                    resolve(get_ctx);
-                }
-            };
-            request.onerror = function (event) {
-                get_ctx.error = (0, utilities_1.cloneError)(request.error);
-                if (get_ctx.on_error) {
-                    (0, utilities_1.safeApply)(get_ctx.on_error, [get_ctx]);
-                }
-                reject(get_ctx);
-            };
-        });
-    },
-    /**
-     * Counts the number of entries in a specific index.
-     * @param count_ctx The context object.
-     * @returns Promise<DashContext>
-     */
-    countEntries: function (count_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a, _b;
-            var request = (_b = (_a = count_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.index(count_ctx.index)) === null || _b === void 0 ? void 0 : _b.count();
-            request === null || request === void 0 ? void 0 : request.addEventListener('success', function () {
-                count_ctx.total = request.result;
-                if (count_ctx.on_success) {
-                    (0, utilities_1.safeApply)(count_ctx.on_success, [count_ctx]);
-                }
-                resolve(count_ctx);
-            });
-            request === null || request === void 0 ? void 0 : request.addEventListener('error', function (event) {
-                count_ctx.error = (0, utilities_1.cloneError)(event.target.error);
-                if (count_ctx.on_error) {
-                    (0, utilities_1.safeApply)(count_ctx.on_error, [count_ctx]);
-                }
-                reject(count_ctx);
-            });
-        });
-    }
-};
-exports.default = exports.indexesMethods;

package/dist/store/index.js

@@ -1,97 +0,0 @@
-"use strict";
-/**
- * Store methods
- * @module store
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.storeMethods = void 0;
-var utilities_1 = require("../utilities");
-// Store methods
-exports.storeMethods = {
-    /**
-     * Clear a store.
-     * @param clear_ctx
-     * @returns Promise<DashContext>
-     */
-    clear: function (clear_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a;
-            var request = (_a = clear_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.clear();
-            request === null || request === void 0 ? void 0 : request.addEventListener('success', function () {
-                if (clear_ctx.on_success) {
-                    clear_ctx.on_success(clear_ctx); // Call the success callback here
-                }
-                resolve(clear_ctx);
-            });
-            request === null || request === void 0 ? void 0 : request.addEventListener('error', function (event) {
-                clear_ctx.error = (0, utilities_1.cloneError)(event.target.error);
-                if (clear_ctx.on_error) {
-                    clear_ctx.on_error(clear_ctx); // Call the error callback here
-                }
-                reject(clear_ctx);
-            });
-        });
-    },
-    /**
-     * Remove a store entry.
-     * @param remove_ctx
-     * @returns Promise<DashContext>
-     */
-    remove: function (remove_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a;
-            var request = (_a = remove_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.delete(remove_ctx.key);
-            request === null || request === void 0 ? void 0 : request.addEventListener('success', function () {
-                if (remove_ctx.on_success) {
-                    remove_ctx.on_success(remove_ctx); // Call the success callback here
-                }
-                resolve(remove_ctx);
-            });
-            request === null || request === void 0 ? void 0 : request.addEventListener('error', function (event) {
-                remove_ctx.error = (0, utilities_1.cloneError)(event.target.error);
-                if (remove_ctx.on_error) {
-                    remove_ctx.on_error(remove_ctx); // Call the error callback here
-                }
-                reject(remove_ctx);
-            });
-        });
-    },
-    /**
-     * Get a store entry.
-     * @param get_ctx
-     * @returns Promise<DashContext>
-     */
-    get: function (get_ctx) {
-        return new Promise(function (resolve, reject) {
-            var _a, _b, _c;
-            var request = (0, utilities_1.exists)(get_ctx.index)
-                ? (_b = (_a = get_ctx.objectstore) === null || _a === void 0 ? void 0 : _a.index(get_ctx.index)) === null || _b === void 0 ? void 0 : _b.get(get_ctx.key)
-                : (_c = get_ctx.objectstore) === null || _c === void 0 ? void 0 : _c.get(get_ctx.key);
-            request === null || request === void 0 ? void 0 : request.addEventListener('success', function () {
-                get_ctx.entry = request.result;
-                if (!get_ctx.entry) {
-                    get_ctx.error = { message: 'missing', name: 'DashNoEntry' };
-                    if (get_ctx.on_error) {
-                        get_ctx.on_error(get_ctx); // Call the error callback here
-                    }
-                    reject(get_ctx);
-                }
-                else {
-                    if (get_ctx.on_success) {
-                        get_ctx.on_success(get_ctx); // Call the success callback here
-                    }
-                    resolve(get_ctx);
-                }
-            });
-            request === null || request === void 0 ? void 0 : request.addEventListener('error', function (event) {
-                get_ctx.error = (0, utilities_1.cloneError)(event.target.error);
-                if (get_ctx.on_error) {
-                    get_ctx.on_error(get_ctx); // Call the error callback here
-                }
-                reject(get_ctx);
-            });
-        });
-    }
-};
-// Export the store methods
-exports.default = exports.storeMethods;

package/dist/stores/index.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.storesMethods = void 0;
-/**
- * Stores methods.
- * @Module stores
- */
-var utilities_1 = require("../utilities");
-// Store methods
-exports.storesMethods = {
-    /**
-     * Get all object stores from the current database.
-     * @param get_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    get: function (get_ctx) {
-        var _a;
-        // This method retrieves all object stores synchronously or asynchronously via an on_success callback.
-        get_ctx.stores = (_a = get_ctx.db) === null || _a === void 0 ? void 0 : _a.objectStoreNames;
-        (0, utilities_1.safeApply)(get_ctx.on_success, [get_ctx]);
-    },
-    /**
-     * Add a new object store to the current database.
-     * @param add_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    add: function (add_ctx) {
-        var _a;
-        // This method adds a new object store in the database, creating a version change.
-        add_ctx.db = (_a = add_ctx.request) === null || _a === void 0 ? void 0 : _a.result;
-        if (!add_ctx.db) {
-            throw new Error("Database is undefined");
-        }
-        var store = add_ctx.db.createObjectStore(add_ctx.store, {
-            keyPath: add_ctx.store_key_path || null,
-            autoIncrement: !!add_ctx.auto_increment
-        });
-        if (add_ctx.request) {
-            add_ctx.db = add_ctx.request.result;
-        }
-        if (add_ctx.indexes) {
-            // If there are indexes defined, we create them in the new store
-            add_ctx.indexes.forEach(function (idx) {
-                store.createIndex(idx.name, idx.keyPath, {
-                    unique: !!idx.unique,
-                    multiEntry: !!idx.multiEntry
-                });
-            });
-        }
-        (0, utilities_1.safeApply)(add_ctx.on_success, [add_ctx]);
-    },
-    /**
-     * Remove an object store from the current database.
-     * @param remove_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    remove: function (remove_ctx) {
-        var _a;
-        // This method deletes a specified object store, triggering a version change.
-        (_a = remove_ctx.db) === null || _a === void 0 ? void 0 : _a.deleteObjectStore(remove_ctx.store);
-        (0, utilities_1.safeApply)(remove_ctx.on_success, [remove_ctx]);
-    },
-    /**
-     * Clear all object stores in the current database.
-     * @param clear_ctx The context object.
-     * @returns Promise<DashContext>
-     * @private
-     */
-    clearAll: function (clear_ctx) {
-        var _a, _b;
-        // This method clears all entries in all object stores in the current database.
-        var storeNames = Array.from(((_a = clear_ctx.db) === null || _a === void 0 ? void 0 : _a.objectStoreNames) || []);
-        var transaction = (_b = clear_ctx.db) === null || _b === void 0 ? void 0 : _b.transaction(storeNames, "readwrite");
-        storeNames === null || storeNames === void 0 ? void 0 : storeNames.forEach(function (storeName) {
-            var objectStore = transaction === null || transaction === void 0 ? void 0 : transaction.objectStore(storeName);
-            objectStore === null || objectStore === void 0 ? void 0 : objectStore.clear();
-        });
-        transaction === null || transaction === void 0 ? void 0 : transaction.addEventListener('complete', function () {
-            (0, utilities_1.safeApply)(clear_ctx.on_success, [clear_ctx]);
-        });
-        transaction === null || transaction === void 0 ? void 0 : transaction.addEventListener('error', function (event) {
-            clear_ctx.error = (0, utilities_1.cloneError)(event.target.error);
-            (0, utilities_1.safeApply)(clear_ctx.on_error, [clear_ctx]);
-        });
-    }
-};
-exports.default = exports.storesMethods;

package/dist/utilities/index.js

@@ -1,174 +0,0 @@
-"use strict";
-/**
- * Common interfaces and utilities.
- * @module utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomId = exports.safeIterate = exports.safeEach = exports.safeApply = exports.isString = exports.isNumber = exports.isObject = exports.isFunction = exports.isRegEx = exports.isBoolean = exports.isArray = exports.isnt = exports.is = exports.isEmpty = exports.exists = exports.contains = exports.clone = exports.cloneError = void 0;
-/**
- * @param {DashContext} ctx - The context.
- * @returns {Promise<DashContext>} The promise object.
- * @private
- */
-var cloneError = function (error) {
-    var clonedError = new Error(error.message);
-    // Optionally, clone the stack trace if it's available
-    if (error.stack) {
-        clonedError.stack = error.stack;
-    }
-    // Clone custom properties
-    Object.keys(error).forEach(function (key) {
-        clonedError[key] = error[key];
-    });
-    return clonedError;
-};
-exports.cloneError = cloneError;
-// Clone function that performs a deep copy of an object, array, or function
-var clone = function (source) {
-    if (source === null || typeof source !== 'object') {
-        return source;
-    }
-    // Handle arrays
-    if (Array.isArray(source)) {
-        return source.map(function (item) { return (0, exports.clone)(item); });
-    }
-    // Handle functions (return the same function reference)
-    if (typeof source === 'function') {
-        return source;
-    }
-    // Handle objects
-    var copy = {};
-    for (var key in source) {
-        if (source.hasOwnProperty(key)) {
-            copy[key] = (0, exports.clone)(source[key]); // Recursively clone properties
-        }
-    }
-    return copy;
-};
-exports.clone = clone;
-// Checks if an item exists in an array or object
-var contains = function (str, substr) {
-    if (typeof str !== 'string' || typeof substr !== 'string') {
-        return false; // Ensure both inputs are strings
-    }
-    // An empty substring should always return true
-    if (substr === '') {
-        return true;
-    }
-    return str.includes(substr); // Use built-in includes method for substring checking
-};
-exports.contains = contains;
-// Checks whether a value exists
-var exists = function (value) {
-    return value !== null && value !== undefined;
-};
-exports.exists = exists;
-// Checks if a variable is empty
-var isEmpty = function (mixed_var) {
-    // Handle null and undefined cases
-    if (mixed_var === null || mixed_var === undefined) {
-        return true;
-    }
-    // Handle objects (including arrays)
-    if (typeof mixed_var === 'object') {
-        return Object.keys(mixed_var).length === 0;
-    }
-    // Handle strings (empty string should return true)
-    if (typeof mixed_var === 'string') {
-        return mixed_var.length === 0;
-    }
-    // For numbers and booleans, they are considered "not collections" and hence should return true
-    if (typeof mixed_var === 'number' || typeof mixed_var === 'boolean') {
-        return true;
-    }
-    return false;
-};
-exports.isEmpty = isEmpty;
-var is = function (a, b) {
-    return Object.is(a, b);
-};
-exports.is = is;
-var isnt = function (a, b) {
-    return a !== b;
-};
-exports.isnt = isnt;
-exports.isArray = Array.isArray;
-var isBoolean = function (mixed_var) { return typeof mixed_var === 'boolean'; };
-exports.isBoolean = isBoolean;
-var isRegEx = function (mixed_var) { return mixed_var instanceof RegExp; };
-exports.isRegEx = isRegEx;
-var isFunction = function (value) {
-    if (typeof value !== 'function') {
-        return false;
-    }
-    // Check if it's a class constructor by examining the function's string representation
-    var isClass = /^class\s/.test(Function.prototype.toString.call(value));
-    return !isClass;
-};
-exports.isFunction = isFunction;
-var isObject = function (value) {
-    return Object.prototype.toString.call(value) === '[object Object]';
-};
-exports.isObject = isObject;
-var isNumber = function (mixed_var) { return typeof mixed_var === 'number'; };
-exports.isNumber = isNumber;
-var isString = function (value) {
-    return typeof value === 'string' || value instanceof String;
-};
-exports.isString = isString;
-// Applies a function if it's defined
-var safeApply = function (fn, args, context, err) {
-    if (typeof fn === 'function')
-        return fn.apply(context || {}, args || []);
-    if (typeof err === 'function')
-        return (0, exports.safeApply)(err, []);
-};
-exports.safeApply = safeApply;
-// Iterates through an array and applies a callback function
-var safeEach = function (items, callback, inc) {
-    if (inc === void 0) { inc = 1; }
-    for (var x = 0; x < items.length; x += inc) {
-        (0, exports.safeApply)(callback, [items[x], x]);
-    }
-};
-exports.safeEach = safeEach;
-// Iterates through an object's properties and applies a callback function
-var safeIterate = function (item, callback) {
-    for (var attr in item) {
-        if (item.hasOwnProperty(attr)) {
-            callback(attr, item[attr]);
-        }
-    }
-};
-exports.safeIterate = safeIterate;
-// Generates a random string ID
-var randomId = function (len, charset) {
-    if (len === void 0) { len = 16; }
-    if (charset === void 0) { charset = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; }
-    var str = '';
-    for (var i = 0; i < len; i++) {
-        str += charset.charAt(Math.floor(Math.random() * charset.length));
-    }
-    return str;
-};
-exports.randomId = randomId;
-exports.default = {
-    cloneError: exports.cloneError,
-    clone: exports.clone,
-    contains: exports.contains,
-    exists: exports.exists,
-    isEmpty: exports.isEmpty,
-    is: exports.is,
-    isnt: exports.isnt,
-    isArray: exports.isArray,
-    isBoolean: exports.isBoolean,
-    isRegEx: exports.isRegEx,
-    isFunction: exports.isFunction,
-    isObject: exports.isObject,
-    isNumber: exports.isNumber,
-    isString: exports.isString,
-    safeApply: exports.safeApply,
-    safeEach: exports.safeEach,
-    safeIterate: exports.safeIterate,
-    randomId: exports.randomId
-};

package/documentation/database/closing.md

@@ -1,3 +0,0 @@
-Databases can be [`close`d](http://www.w3.org/TR/IndexedDB/#dfn-database-close-1).
-
-Databases are browser resources and, like all resources, expensive for the brower to maintain. Just as opening a database is the first step to doing anything in IndexedDB, closing a database is usually a good last step.

package/documentation/database/getting.md

@@ -1 +0,0 @@
-It's typically not possible to enumerate all databases for a host. Typically the programmer must already know the name of our database in order to of opening it, else create a new one. The exception is in Chrome, which offers a non-standard way of enumerating existing databases for a host.

package/documentation/database/opening.md

@@ -1,5 +0,0 @@
-To get to objects, you have to through object stores, and to get to object stores you have to go through databases. So the first step in interaction with `IndexedDB` is almost always to open a database. Database open requests are instances of [`IDBOpenDBRequest`](https://developer.mozilla.org/en-US/docs/Web/API/IDBOpenDBRequest).
-
-Opening an existing database and creating a new one work in the same way: if the name passed matches an existing database, that database is opened; if the name doesn't match an existing database, a new one will be created when opened using a unique name. Opening a new database, or opening an existing database with a version greather than the current version, will trigger a `versionchange` event.
-
-As written in the spec, an IDBDatabase interface "represents a connection to a database." There can be multiple connections at any given time. So long as a reference to that object exists, the connection should remain open unless closed explictly using the `close()` method on IDBDatabase.

package/documentation/database/removing.md

@@ -1,3 +0,0 @@
-Databases can be removed or "deleted" and their resources will be freed up for use elsewhere.
-
-Once a database is deleted you can open a new one with the same name; this is similar to a `versionchange` transaction but destroys and object stores and their contents.

package/documentation/databases.md

@@ -1,21 +0,0 @@
-A [`database`](http://www.w3.org/TR/IndexedDB/#dfn-database) houses object stores and have two distinguishing characteristics: a [`name`](http://www.w3.org/TR/IndexedDB/#dfn-object-store-name) (string) and [`version`](http://www.w3.org/TR/IndexedDB/#dfn-version) (number). They are reached through an instance of [`IDBFactory`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory) object at the `window.indexedDB` namespace
-
-##### Names
-
-When opening a database, a programmer must specify a databases [`name`](http://www.w3.org/TR/IndexedDB/#dfn-object-store-name) and optionally its version. A database name is case-sensitive and cannot change.
-
-##### Versions
-
-#### Database Versions
-
-[`Version`](http://www.w3.org/TR/IndexedDB/#dfn-version) numbers are positive whole numbers greater than zero. A programmer can set a database's version manually or implictly by opening an existing database name with a greater version number than the database contains. While a database's name can never change, the database version changes all the time.
-
-Specifying a version greater than the current allows us to entry a "version change" transaction that enables database schema changes. When no version is specified, the database will open with the most recent database version.
-
-Database version numbers are stored as [8-byte "int long long"](https://developer.mozilla.org/en-US/docs/IndexedDB/Using_IndexedDB#Opening_a_database) in the underlying C programming language implementation of IDB  and can number anywhere between `1` and `18446744073709551615`.
-
-##### `versionchange` transactions
-
-A version number can represent only one schema for particular database, but a programmer can change a database's layout by incrementing its version number, triggering something called a "`versionchange`" transaction. [Version changes](https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction#VERSION_CHANGE) preserve databases object stores and indexes, but from within a `versionchange` callback the programmer is allowed to make modifications to a database schema.
-
-Database operations that require a version change include both creating and deleting object stores, and both creating and deleting indexes.

package/documentation/entries.md

@@ -1,13 +0,0 @@
-The base unit of data in IDB is a [`record`](http://www.w3.org/TR/IndexedDB/#dfn-record) or "entry" and IndexedDB is capable of storing as records most standard types of JavaScript data. To copy values to the database, IDB uses something called the "[`structured clone algorithm`](http://www.w3.org/TR/IndexedDB/#dfn-structured-clone-algorithm)".
-
-IDB only stores JavaScript list objects, but the values associated with keys on those objects that can typically be any value that "[cloned](http://www.w3.org/TR/IndexedDB/#dfn-structured-clone)", which includes both the basic JavaSript primitives and more complex object types: null values, `Boolean`s, `Number`s, `String`s, `Date`s, `Array`s, other `Object`s and even advanced types such as RegExp, Blob, File, FileList and ImageData objects. The only standard object type IDB's structured clone algorithm cannot deal with are function objects. Thus JavaScript functions cannot be stored in their native object form.
-
-#### Working With One Entry At A Time
-
-It's possible to ["`add`"](http://www.w3.org/TR/IndexedDB/#widl-IDBObjectStore-add) (create), ["`get`"](http://www.w3.org/TR/IndexedDB/#widl-IDBObjectStore-get) (read), ["`put`"](http://www.w3.org/TR/IndexedDB/#widl-IDBObjectStore-put) (update an existing object, else create a new one) and ["`delete`"](http://www.w3.org/TR/IndexedDB/#widl-IDBObjectStore-delete) (destroy) single objects in an object store. Generally, to `delete` or `get` a record requires using its `key`, but both `add` and `put` operations do not require a key and will handily return an object's object store key value when added or put (useful when using a [`key generator`](http://www.w3.org/TR/IndexedDB/#dfn-key-generator) and the key is unknown until after insertion).
-
-#### Working With Multiple Entries At The Same Time
-
-When querying for more than one object we must use indexes, and to use indexes we in complex manners we typically need to use a special type of request called a "cursor." When you want to ask for a [`range`](http://www.w3.org/TR/IndexedDB/#dfn-range) of data on an index, what you get back is not the data itself but rather a cursor, which is a reference to a [`position`](http://www.w3.org/TR/IndexedDB/#dfn-position) in the index and fires asyncronous callbacks as that position changes.
-
-When a cursor's callbacks fire, the programmer can place a request and then either "continue" the cursor or abandon it. This process continues until either the programmer is done with the request or the cursor has [exhausted](http://www.w3.org/TR/IndexedDB/#dfn-got-value) the results from its  request [`source`](http://www.w3.org/TR/IndexedDB/#dfn-cursor-source).

package/documentation/entry/adding.md

@@ -1 +0,0 @@
-When adding or putting values, the various uniqueness rules for the store and indexes together apply to any entries added to that object store. 

package/documentation/entry/getting.md

@@ -1,4 +0,0 @@
-#### Getting An Object From An Object Store
-
-
-#### Getting Multiple Objects From A Database

package/documentation/entry/removing.md

@@ -1,3 +0,0 @@
-#### Removing Object From An Object Store
-
-#### Removing Multiple Objects From A Database

package/documentation/general/security.md

@@ -1,10 +0,0 @@
-IDB is typically available in both the main `window` and in Web Workers thanks to an abstracted [`IDBEnvironment`](https://developer.mozilla.org/en-US/docs/Web/API/IDBEnvironment) interface. It is restricted to a given [`origin`](http://www.w3.org/TR/IndexedDB/#dfn-origin), and
-[`same-origin`](http://www.w3.org/TR/IndexedDB/#dfn-same-origin) security restrictions apply. 
-
-Most browsers will ask a user's permission before allowing IDB to store data locally. Although the specification does not specify a size limit, some browsers enforce one.
-
-Firefox has no size limit but will ask permission before storing data larger than 50 megabytes. It exposes "quota" information via the `dom.indexedDB.warningQuota` factory attribute for the programmer to judge utilization.
-
-Chrome automatically grants "[`temporary`](https://developers.google.com/chrome/whitepapers/storage#temporary)" storage to IDB and allocates a maximum of 20% of its "shared storage pool". Chrome also allows a "[`persistent`](https://developers.google.com/chrome/whitepapers/storage#persistent)" storage mode that asks the user to authorize a host for offline storage but enforces no size limitations other than user disk space.
-
-IE allows IDB up to 250 megabytes of space and provides the [`window.indexedDB.remainingSpace`](http://msdn.microsoft.com/en-us/library/windows/apps/cc197016.aspx) factory attribute for the programmer to judge utilization.

package/documentation/general/transaction/requests.md

@@ -1,3 +0,0 @@
-Certain transactions return data, or "[`results`](http://www.w3.org/TR/IndexedDB/#dfn-request-result)", from the database. These transactions are called "[`requests`](http://www.w3.org/TR/IndexedDB/#dfn-request)" and with the exception of database opening, the values are always various combinations of object "keys" and "values" and instances of [`IDBRequest`](https://developer.mozilla.org/en-US/docs/Web/API/IDBRequest). [`Request transactions`](http://www.w3.org/TR/IndexedDB/#dfn-request-transaction) are just that: a transaction request," namely the act of asking for something rather than the getting of it. A programmer encounters them when dealing with `IDBObjectStore`, `IDBIndex` or `IDBCursor` objects. They have a `done` attribute and, alternatively displaying the same information, a `readyState` that says whether they are "`pending`" or "`done`". Unlike many databases, requests are not fulfilled immediately after being [`placed`](http://www.w3.org/TR/IndexedDB/#dfn-place-request), or "synconronously"; however, these non-immediate responses are rather "asyncronous", and the mechanism a programmer uses to await an asynconrous reponse is by coding a "callback" function IDB can invoke on various "events" such as a successful response.
-
-There are various types of callbacks in IDB depending on the type of transaction. Requests generally have "onsuccess", "onerror and "onabort" callbacks. Others include "onupgradeneeded", "onclose" and "onblocked," sometimes seen when working with databases. Each event has a different meaning depending on the transaction, but for example "onsuccess", "onupgraded" are generally a good event for the programmer while "onerror", "onabort" and "onblocked" mean something went awry for him.

package/documentation/general/transactions.md

@@ -1,5 +0,0 @@
-In IDB, work [tasked](http://www.w3.org/TR/IndexedDB/#dfn-task) to a database [queue](http://www.w3.org/TR/IndexedDB/#dfn-queue-a-task) is called a "[`transaction`](http://www.w3.org/TR/IndexedDB/#dfn-transaction)". A transaction is an instance of [`IDBTransaction`](https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction) and characterized by its "[`scope`](http://www.w3.org/TR/IndexedDB/#dfn-scope)". Transaction scope, in turn, is characterized by both the work to be done and where the programmer wants the work to happen. To create a transaction against an open database, a programmer names the object stores on which she'd like to operate, and optionally specifies what type of transaction she'd like to create.
-
-There are three "[`modes`](http://www.w3.org/TR/IndexedDB/#dfn-mode)" of transactions: "[`readwrite`](http://www.w3.org/TR/IndexedDB/#dfn-read_write)", "[`readonly`](http://www.w3.org/TR/IndexedDB/#dfn-read_only)" and "[`versionchange`](http://www.w3.org/TR/IndexedDB/#dfn-version_change)". These are an instance of an interface called IDBTransactionMode. The default is "readonly", convienient because changing a data via a "write" is generally more expensive than to "read" that data. The granularity and providing of "readonly" vs. "readwrite" offers the programmer an the opportunity to speed up her code depending on her needs. The final transaction type, "versionchange", is used when changing the schema of a database.
-
-The [`lifetime`](http://www.w3.org/TR/IndexedDB/#dfn-transaction-lifetime) of a transactions lasts as long as it's referenced: it's "`active`" so long as it's being referenced, after which it is said to be "`finished`" and the transaction is [`committed`](http://www.w3.org/TR/IndexedDB/#dfn-commit).

package/documentation/index/creating.md

@@ -1 +0,0 @@
-The options for creating a new `index` are similar to those when creating an object store: a `key path` is given using the standard key syntax and the `unique` and `multirow` options can both be used. The ["`unique`"](http://www.w3.org/TR/IndexedDB/#dfn-multirow#dfn-unique) parameter tells the browser not to allow two values to correspond to the same key and the ["multirow"](http://www.w3.org/TR/IndexedDB/#dfn-multirow) flag controls how the index behaves when dealing with `Array` values.

package/documentation/index/getting.md

@@ -1 +0,0 @@
-With a string index name, it's possible to get a reference to an existing index from an object store.

package/documentation/index/iterating.md

@@ -1 +0,0 @@
-Using an object store on an open database, it's possible to get a list of indexes names. This list is an `Array`-like collection of string names.

package/documentation/index/removing.md

@@ -1 +0,0 @@
-With a string index name, it's possible to get a reference to an existing index from an object store.

package/documentation/indexes.md

@@ -1,3 +0,0 @@
-[`Indexes`](http://www.w3.org/TR/IndexedDB/#dfn-index) are the way values are generally found in an object store. An `index` is an instance of [`IDBIndex`](https://developer.mozilla.org/en-US/docs/Web/API/IDBIndex) and is a list of keys and values and has two characterizing components: the key path to find the data and the record value itself. `Indexes` stored primarily by key, and secondarily by their values, in ascending order.
-
-Both adding and removing indexes requires a `versionchange` transaction.

package/documentation/key/cursors.md

@@ -1,5 +0,0 @@
-Using an index and a key range for that index, you can use a "[`cursor`](http://www.w3.org/TR/IndexedDB/#dfn-cursor)" to get, put and delete [`values`](http://www.w3.org/TR/IndexedDB/#dfn-cursor-value) one at a time but in single request. Cursors are also capable of "[`advancing`](http://www.w3.org/TR/IndexedDB/#widl-IDBCursor-advance)" and, in effect, skip a number of objects in an index for a given key range.
-
-Cursors traverse an index matching a given "key range". There is no limit on the number of cursors that can be used at the same time.
-
-Two different types of cursors: cursors that read just keys (instances of [`IDBCursor`](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursor)) and cursors that read keys and values [`IDBCursorWithValue`](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursorWithValue) which are created on an index using the [`openKeyCursor`](http://www.w3.org/TR/IndexedDB/#widl-IDBIndex-openKeyCursor) and [`openCursor`](http://www.w3.org/TR/IndexedDB/#widl-IDBIndex-openCursor) methods respectively.