Fix RIFFFile signture export

rochars · Jan 2, 2020 · 357b9b8 · 357b9b8
1 parent 8abf6e1
commit 357b9b8
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 31 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
 # CHANGELOG
 
-## version 0.0.1 (2019-08-09)
+## version 1.0.1 (2020-01-02)
+- Fix RIFFFile signature export
diff --git a/README.md b/README.md
@@ -92,7 +92,9 @@ RIFFFile.chunkSize = 0;
 RIFFFile.format = '';
 /**
  * An object representing the signature of all chunks in the file.
- * @type {!Object<string, *>}
+ * @type {
+  {chunkId: string, chunkSize: number, format: string, subChunks: Array}
+ }
  */
 RIFFFile.signature = {
   /** @type {string} */

diff --git a/dist/riff-file.js b/dist/riff-file.js
diff --git a/docs/index.html b/docs/index.html
@@ -138,7 +138,9 @@ <h3>The RIFFFile properties</h3>
 RIFFFile.format = '';
 /**
  * An object representing the signature of all chunks in the file.
- * @type {!Object&lt;string, *>}
+ * @type {
+  {chunkId: string, chunkSize: number, format: string, subChunks: Array}
+ }
  */
 RIFFFile.signature = {
   /** @type {string} */

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -99,9 +99,16 @@ <h1 class="page-title">index.js</h1>
     this.format = '';
     /**
      * An object representing the signature of all chunks in the file.
-     * @type {!Object}
+     * @type {
+      {chunkId: string, chunkSize: number, format: string, subChunks: Array}
+     }
      */
-    this.signature = {};
+    this.signature = {
+      chunkId : '',
+      chunkSize : 0,
+      format: '',
+      subChunks: []
+    };
     /**
      * @type {number}
      * @protected
@@ -155,7 +162,7 @@ <h1 class="page-title">index.js</h1>
     * @protected
     */
   findChunk(chunkId, multiple=false) {
-    /** @type {!Array&lt;!Object>} */
+    /** @type {!Array|null} */
     let chunks = this.signature.subChunks;
     /** @type {!Array&lt;!Object>} */
     let chunk = [];

diff --git a/docs/module-riff-file.RIFFFile.html b/docs/module-riff-file.RIFFFile.html
@@ -394,7 +394,7 @@ <h4 class="name" id="head"><span class="type-signature">(protected) </span>head<
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line65">line 65</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line72">line 72</a>
     </li></ul></dd>
 
 
@@ -452,7 +452,7 @@ <h5>Type:</h5>
 
 
 
-<h4 class="name" id="signature"><span class="type-signature">(non-null) </span>signature<span class="type-signature"> :Object</span></h4>
+<h4 class="name" id="signature"><span class="type-signature"></span>signature<span class="type-signature"> :Object</span></h4>
 
 
 
@@ -463,7 +463,7 @@ <h4 class="name" id="signature"><span class="type-signature">(non-null) </span>s
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line60">line 60</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line62">line 62</a>
     </li></ul></dd>
 
 
@@ -536,7 +536,7 @@ <h4 class="name" id="supported_containers"><span class="type-signature">(protect
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line79">line 79</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
     </li></ul></dd>
 
 
@@ -609,7 +609,7 @@ <h4 class="name" id="uInt32"><span class="type-signature">(protected) </span>uIn
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line72">line 72</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line79">line 79</a>
     </li></ul></dd>
 
 
@@ -688,7 +688,7 @@ <h4 class="name" id="findChunk"><span class="type-signature">(protected) </span>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line113">line 113</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a>
     </li></ul></dd>
 
 
@@ -877,7 +877,7 @@ <h4 class="name" id="readString"><span class="type-signature">(protected) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line140">line 140</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
     </li></ul></dd>
 
 
@@ -1058,7 +1058,7 @@ <h4 class="name" id="readUInt32"><span class="type-signature">(protected) </span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line154">line 154</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
     </li></ul></dd>
 
 
@@ -1216,7 +1216,7 @@ <h4 class="name" id="setSignature"><span class="type-signature">(protected) </sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="index.js.html">index.js</a>, <a href="index.js.html#line87">line 87</a>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line94">line 94</a>
     </li></ul></dd>
 
 

diff --git a/externs/riff-file.js b/externs/riff-file.js
@@ -55,9 +55,16 @@ RIFFFile.prototype.format = '';
 
 /**
  * An object representing the signature of all chunks in the file.
- * @type {!Object}
+ * @type {
+  {chunkId: string, chunkSize: number, format: string, subChunks: Array}
+ }
  */
-RIFFFile.prototype.signature = {};
+RIFFFile.prototype.signature = {
+  chunkId : '',
+  chunkSize : 0,
+  format: '',
+  subChunks: []
+};
 
 /**
  * @type {number}

diff --git a/index.js b/index.js
@@ -55,9 +55,16 @@ export class RIFFFile {
     this.format = '';
     /**
      * An object representing the signature of all chunks in the file.
-     * @type {!Object}
+     * @type {
+      {chunkId: string, chunkSize: number, format: string, subChunks: Array}
+     }
      */
-    this.signature = {};
+    this.signature = {
+      chunkId : '',
+      chunkSize : 0,
+      format: '',
+      subChunks: []
+    };
     /**
      * @type {number}
      * @protected
@@ -111,7 +118,7 @@ export class RIFFFile {
     * @protected
     */
   findChunk(chunkId, multiple=false) {
-    /** @type {!Array<!Object>} */
+    /** @type {!Array|null} */
     let chunks = this.signature.subChunks;
     /** @type {!Array<!Object>} */
     let chunk = [];

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "riff-file",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Read data from RIFF files.",
   "homepage": "https://github.com/rochars/riff-file",
   "author": "Rafael da Silva Rocha <rocha.rafaelsilva@gmail.com>",