v1.4.4

ShakeFile.js

@@ -2,26 +2,31 @@
  * @file Class representing the ShakeFile base class.
  * @copyright Jyrone Parker 2023 
  * @author Jyrone Parker <jyrone.parker@gmail.com>
- * @version 1.4.2
+ * @version 1.4.4
  */
 class ShakeFile {
     /**
      * Create a ShakeFile.
+     * @class ShakeFile
      * @param {object} config - The config object.
      * @param {File | Blob| null} config.file - The File/Blob to be acted on 
+     * @param {Boolean} config.showDom - Boolean flag to determin if DOM elements should be created
      */
-    constructor ({file = null, obj = null, showDom = false}) {
+
+    encodedData;
+    decodedData;
+    constructor ({file = null, showDom = false}) {
         this.file = file
-        this.obj = obj
-
-        this.encodedData = null
-        this.decodedData = ''
         this.showDom = showDom
         if(this.showDom) {
             this.addToDom()
         }
     }
-
+    /**
+     * @function addToDom
+     * Add file elements to DOM.
+     * @return {void} - no return type
+     */
     addToDom () {
         this.mainDiv = document.createElement('div')
         this.mainDiv.id = 'main-div'

docs/README.md

@@ -1,3 +1,19 @@
+## Classes
+
+<dl>
+<dt><a href="#ShakeFile">ShakeFile</a></dt>
+<dd></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#addToDom
+Add file elements to DOM.">addToDom
+Add file elements to DOM.()</a> ⇒ <code>void</code></dt>
+<dd></dd>
+</dl>
+
 <a name="ShakeFile"></a>
 
 ## ShakeFile
@@ -17,9 +33,17 @@ Create a ShakeFile.
 | --- | --- | --- |
 | config | <code>object</code> | The config object. |
 | config.file | <code>File</code> \| <code>Blob</code> \| <code>null</code> | The File/Blob to be acted on |
+| config.showDom | <code>Boolean</code> | Boolean flag to determin if DOM elements should be created |
 
 <a name="ShakeFile+saveFile"></a>
 
 ### shakeFile.saveFile() ⇒
 **Kind**: instance method of [<code>ShakeFile</code>](#ShakeFile)  
-**Returns**: Boolean  
+**Returns**: Boolean  
+<a name="addToDom
+Add file elements to DOM."></a>
+
+## addToDom
+Add file elements to DOM.() ⇒ <code>void</code>
+**Kind**: global function  
+**Returns**: <code>void</code> - - no return type  

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shake-file",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "Pure Javascript package for using the File System API",
   "main": "index.js",
   "scripts": {