WaveFile.toBuffer() doc on README

rochars · May 7, 2018 · de0a164 · de0a164
1 parent 2e96db2
commit de0a164
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,11 @@ wavDataURI = wav.toDataURI();
 #### WaveFile.fromBuffer()
 Load a .wav file from a byte buffer into a WaveFile object:
 ```javascript
+wav.fromBuffer(buffer);
+```
+
+This is the same as passing the buffer when creating the WaveFile object:
+```javascript
 let wav = new Wavefile(buffer);
 ```
 

diff --git a/docs/WaveFile.html b/docs/WaveFile.html
@@ -3316,7 +3316,7 @@ <h4 class="name" id="toRIFX"><span class="type-signature"></span>toRIFX<span cla
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:36:13 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:45:23 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -110,6 +110,7 @@ <h2>Use</h2><pre class="prettyprint source lang-javascript"><code>const fs = req
 // Call toDataURI() to get the file as a base64-encoded
 // DataURI to load the file a web browser:
 wavDataURI = wav.toDataURI();</code></pre><h3>Main methods:</h3><h4>WaveFile.fromBuffer()</h4><p>Load a .wav file from a byte buffer into a WaveFile object:</p>
+<pre class="prettyprint source lang-javascript"><code>wav.fromBuffer(buffer);</code></pre><p>This is the same as passing the buffer when creating the WaveFile object:</p>
 <pre class="prettyprint source lang-javascript"><code>let wav = new Wavefile(buffer);</code></pre><h4>WaveFile.fromScratch()</h4><p>Create a WaveFile object with the arguments you pass:</p>
 <pre class="prettyprint source lang-javascript"><code>// A mono, 44.1 kHz, 32-bit .wav file with just 4 samples:
 wav.fromScratch(1, 44100, '32', [0, -2147483648, 2147483647, 4]);</code></pre><h4>WaveFile.toBuffer()</h4><p>Return a Uint8Array with the WaveFile object data. The buffer is a .wav file and can be written to disk:</p>
@@ -342,7 +343,7 @@ <h2>LICENSE</h2><p>Copyright (c) 2017-2018 Rafael da Silva Rocha.</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:36:13 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:45:23 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -1306,7 +1306,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:36:13 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon May 07 2018 00:45:23 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>