Merge pull request #107 from SpringRoll/chore/docs-update

Chore/docs update

Author: 902seanryan

README.md

@@ -27,9 +27,9 @@ export class SavedData {
    * Save a variable.
    * @method write
    * @static
-   * @param {String} name The name of the value to save
-   * @param {*} value The value to save. This will be run through JSON.stringify().
-   * @param {Boolean} [tempOnly=false] If the value should be saved only in the current browser session.
+   * @param {string} name The name of the value to save
+   * @param {string} value The value to save. This will be run through JSON.stringify().
+   * @param {boolean} [tempOnly=false] If the value should be saved only in the current browser session.
    */
   static write(name, value, tempOnly = false) {
 
@@ -68,7 +68,7 @@ export class SavedData {
   /**
    * Open a connection with the IDB Database and optionally add or delete
    * Indexes and stores
-   * 
+   *
    * @param {string} dbName The name of your IndexedDB database
    * @param {string} dbVersion The version number of the database. Additions and deletions will be ignored if lower than current version number
    * @param {JSON} additions Any additions to the structure of the database
@@ -111,7 +111,7 @@ export class SavedData {
           });
         }
       }
-      
+
       if (deletions != null) {
         if (deletions.indexes != null) {
           // delete indexes first to avoid deleting an index to a store that has already to been deleted
@@ -133,9 +133,9 @@ export class SavedData {
 
   /**
    * Delete a database and all records, stores, and indexes associated
-   * @param {*} dbName Name of the database to delete 
-   * @param {*} options Optionally pass in options
-   * @param {*} callback The callback to be run on success or error. One value will be passed into this function
+   * @param {string} dbName Name of the database to delete
+   * @param {object} options Optionally pass in options
+   * @param {function} callback The callback to be run on success or error. One value will be passed into this function
    */
   IDBDeleteDB(dbName, options = null, callback = {}) {
     const request = options != null ? indexedDB.deleteDatabase(dbName, options): indexedDB.deleteDatabase(dbName);
@@ -153,28 +153,28 @@ export class SavedData {
   /**
    * Add a record to a given store
    * @param {string} storeName The name of the store from which the record will be updated
-   * @param {string} key the key of the record to be updated 
-   * @param {*} value The value for the record with the given key to be updated
+   * @param {string} key the key of the record to be updated
+   * @param {string} value The value for the record with the given key to be updated
    * @param {function} callback The method to call on success or failure. A single value will be passed in
    */
   IDBAdd(storeName, value, key, callback) {
     if ( !this.db && this.dbName != '') {
       this.IDBOpen(this.dbName);
     }
-    
+
     const tx = this.db.transaction(storeName, 'readwrite');
     tx.onerror = () => callback({result: tx.error != null ? tx.error.toString() : 'Aborted: No error given, was the record already added?', success: false});
     tx.onabort = () => callback({result: tx.error != null ? tx.error.toString() : 'Aborted: No error given, was the record already added?', success: false});
-    
+
     tx.oncomplete = () => callback({result: 'Success: Record Added', success: true});
     const store = tx.objectStore(storeName);
     store.add(value, key);
   }
 
   /**
    * Update a record in a given store
-   * @param {string} storeName 
-   * @param {string} key the key of the record to be updated 
+   * @param {string} storeName The name of the store from which the record will be updated
+   * @param {string} key the key of the record to be updated
    * @param {string | object} value The altered object to be updated from the given store
    * @param {function} callback The method to call on success or failure. A single value will be passed in
    */
@@ -185,7 +185,7 @@ export class SavedData {
 
     const tx = this.db.transaction(storeName, 'readwrite');
     const store = tx.objectStore(storeName);
-    
+
     const updateRequest = store.put(value, key);
 
     updateRequest.onsuccess = () => {
@@ -197,8 +197,8 @@ export class SavedData {
 
   /**
    * Delete a given record within a given store
-   * @param {*} storeName 
-   * @param {*} key 
+   * @param {string} storeName The name of the store from which the record will be removed
+   * @param {string} key the key of the record to be removed
    * @param {function} callback The method to call on success or failure. A single value will be passed in
    */
   IDBRemove(storeName, key, callback) {
@@ -217,8 +217,8 @@ export class SavedData {
 
   /**
    * Return a record from a given store with a given key
-   * @param {string} storeName 
-   * @param {string} key The key for the record in the given store 
+   * @param {string} storeName the name of the store to read from
+   * @param {string} key The key for the record in the given store
    * @param {function} callback The method to call on success or failure. A single value will be passed in
    */
   IDBRead(storeName, key, callback) {
@@ -228,7 +228,7 @@ export class SavedData {
     const store = tx.objectStore(storeName);
 
     tx.onerror = () => callback({result: this.db.error.toString(), success: false});
-    
+
     const readRequest = store.get(key);
 
     readRequest.onsuccess = () => {
@@ -239,9 +239,11 @@ export class SavedData {
 
   /**
    * Get all keys with given index
+   * @param {string} storeName the name of the store to be read from
+   * @param {string} indexName the name of the index to be read from
    * @param {string} query Optionally give a keyRange of records to return
    * @param {string} count Optionally give a max limit on records to be returned
-   * @param {function} callback The method to call on success or failure. A single value will be passed in
+   * @param {function} callback The method to call on success or failure. A single value will be passed in as a parameter
    */
   IDBGetIndexKeys (storeName, indexName, query = null, count = null, callback = {}) {
     // Open transaction with a store
@@ -280,7 +282,7 @@ export class SavedData {
     const tx = this.db.transaction(storeName, 'readonly');
     // Get the store object from the transaction
     const store = tx.objectStore(storeName);
-    
+
     const readRequest = count != null ? store.getAll(null, count) : store.getAll();
 
     // const readRequest = store.getAll();
@@ -294,7 +296,7 @@ export class SavedData {
   }
 
   /**
-   * Get the version number of a given database. This will create a database if it doesn't exist. 
+   * Get the version number of a given database. This will create a database if it doesn't exist.
    * Do not call this after opening a connection with the database
    * @param {string} dbName The name of the database for which the version will be returned
    * @param {function} callback The method to call on success or failure. A single value will be passed in
@@ -323,7 +325,7 @@ export class SavedData {
     if ( this.db ) {
       this.db.close();
       callback({result: 'Success: Closed Database Connection', success: true});
-    } 
+    }
   }
-  
+
 }