Merge pull request #7 from BaileyBrightman/develop

Develop

Author: wrbright

README.md

@@ -486,7 +486,72 @@ import { SavedData } from 'springroll-container';
 // Firstly, construct the SavedData object. This is only needed for IndexedDB work
 savedData = new SavedData('dbName');
 
+// Then, open a connection to the database. All changes to the structure of the database should be passed in here
 ```
+Additions is an optional parameter expecting a JSON object with any additions to the databases structure namely new [stores](https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/createObjectStore) and [indexes](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/createIndex). These are placed inside of an array 
+
+Deletions is an optional parameter used to delete any [indexes](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/deleteIndex) or [stores](https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/deleteObjectStore)
+
+``` javascript
+
+let additions = {
+  stores: [{
+    storeName: 'storeOne',
+    // optionally define a keyPath and/or set autoIncrement to true or false
+    options: { keyPath: "taskTitle" }
+  },
+  {
+    storeName: 'storeTwo'
+  }],
+  indexes: [{
+    indexName: 'newIndex',
+    keyPath: 'key',
+    // Any objectParameters for the Index
+    options: {
+      unique: false
+    }
+  }]
+};
+
+// Deletions is an optional parameter used to delete any indexes or stores
+let deletions = {
+  stores: ['storeOne', 'storeTwo'],
+  indexes: ['newIndex']
+};
+
+// Optionally pass in the new database version. Set to true to increment the database version.
+// Leave this parameter out or pass in false to connect without making any changes to the structure of the database
+let dbVersion = 1 
+
+// The name of the database to connect to
+let dbName = 'dbName';
+
+// Finally, pass these parameters in to establish a connection with the database
+savedData.onOpenDb(dbName, dbVersion, additions, deletions);
+```
+
+There are other methods currently supported to interact with the database. These allow you to [Add a record](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/add), [Deleting a record](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/delete), [Reading](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/get), [reading all records](https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/getAll) Each will return a success, or on failure, an error message 
+
+``` javascript
+
+//Delete a record by the key in a specific store
+savedData.IDBRemove('storeName', 'key');
+
+// add a record to a store. The record can be any type of object accepted by indexedDB
+savedData.IDBAdd('storeName', 'record');
+
+// returns the record with the given key from the store with the given storeName
+savedData.IDBRead('storeName', 'key');
+
+// Finally, close the connection to the database
+savedData.closeDb();
+
+// Return all records from a database or optionally a specified amount defined by the second parameter
+savedData.IDBReadAll('storeName');
+savedData.IDBReadAll('storeName', 5);
+
+
+
 All other methods will work the same as the documentation [here](https://github.com/SpringRoll/SpringRoll/tree/main/src/state#userdata);
 
 

src/plugins/UserDataPlugin.js

@@ -57,11 +57,11 @@ export class UserDataPlugin extends BasePlugin {
    * Handler for the userDataRemove event 
    * @method onUserDataRemove
    * @private
-   * @param {string} data The name of the record to be removed
+   * @param {string} name The name of the record to be removed
    * @param {string} type The type of listener for bellhop to send to
    */
-  onUserDataRemove({ data, type }) { 
-    SavedDataHandler.remove(data, () => {
+  onUserDataRemove({ name, type }) { 
+    SavedDataHandler.remove(name, () => {
       this.client.send(type);
     });
   }
@@ -70,20 +70,20 @@ export class UserDataPlugin extends BasePlugin {
    * Handler for the userDataRead event
    * @method onUserDataRead
    * @private   
-   * @param {string} data The name of the record to be removed
+   * @param {string} name The name of the record to be removed
    * @param {string} type The type of listener for bellhop to send to
    */
-  onUserDataRead({ data, type }) {
-    SavedDataHandler.read(data, value => this.client.send(type, value));
+  onUserDataRead({ name, type }) {
+    SavedDataHandler.read(name, value => this.client.send(type, value));
   }
 
   /**
    * Handler for the userDataWrite event
    * @method onUserDataWrite
    * @private
    * @param {string} type The type of listener for bellhop to send to
-   * @param {string} data The name for the record. This is what is used to read or remove the record
-   * @param {object | string} value The data object with the data and value for the record
+   * @param {string} data.name The name for the record. This is what is used to read or remove the record
+   * @param {object | string} data.value The data object with the data and value for the record
    */
   onUserDataWrite({type, data: { name, value } }) {