Skip to content

Commit e6365d6

Browse files
Daniel1984JacobPlaster
authored andcommitted
updating docs for pusle restv2
1 parent 510db26 commit e6365d6

6 files changed

Lines changed: 17 additions & 8 deletions

File tree

docs/RESTv1.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6784,7 +6784,7 @@ <h5>Parameters:</h5>
67846784
<br class="clear">
67856785

67866786
<footer>
6787-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:03:43 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6787+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:04:33 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
67886788
</footer>
67896789

67906790
<script>prettyPrint();</script>

docs/RESTv2.html

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1778,7 +1778,7 @@ <h4 class="name" id="addPulse"><span class="type-signature"></span>addPulse<span
17781778

17791779
<dt class="tag-source">Source:</dt>
17801780
<dd class="tag-source"><ul class="dummy"><li>
1781-
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1452">line 1452</a>
1781+
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1453">line 1453</a>
17821782
</li></ul></dd>
17831783

17841784

@@ -1808,6 +1808,13 @@ <h4 class="name" id="addPulse"><span class="type-signature"></span>addPulse<span
18081808

18091809

18101810

1811+
1812+
<dt class="tag-see">See:</dt>
1813+
<dd class="tag-see">
1814+
<ul>
1815+
<li><a href="https://docs.bitfinex.com/reference#rest-auth-pulse-add">https://docs.bitfinex.com/reference#rest-auth-pulse-add</a></li>
1816+
</ul>
1817+
</dd>
18111818

18121819

18131820

@@ -5933,7 +5940,7 @@ <h4 class="name" id="deletePulse"><span class="type-signature"></span>deletePuls
59335940

59345941
<dt class="tag-source">Source:</dt>
59355942
<dd class="tag-source"><ul class="dummy"><li>
5936-
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1463">line 1463</a>
5943+
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1464">line 1464</a>
59375944
</li></ul></dd>
59385945

59395946

@@ -14796,7 +14803,7 @@ <h4 class="name" id="pulseHistory"><span class="type-signature"></span>pulseHist
1479614803

1479714804
<dt class="tag-source">Source:</dt>
1479814805
<dd class="tag-source"><ul class="dummy"><li>
14799-
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1474">line 1474</a>
14806+
<a href="rest2.js.html">rest2.js</a>, <a href="rest2.js.html#line1475">line 1475</a>
1480014807
</li></ul></dd>
1480114808

1480214809

@@ -19715,7 +19722,7 @@ <h5>Returns:</h5>
1971519722
<br class="clear">
1971619723

1971719724
<footer>
19718-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:03:43 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
19725+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:04:33 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1971919726
</footer>
1972019727

1972119728
<script>prettyPrint();</script>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h3>nonce too small</h3>
127127
<br class="clear">
128128

129129
<footer>
130-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:03:43 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
130+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:04:33 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
131131
</footer>
132132

133133
<script>prettyPrint();</script>

docs/rest1.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ <h1 class="page-title">rest1.js</h1>
661661
<br class="clear">
662662

663663
<footer>
664-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:03:43 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
664+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:04:33 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
665665
</footer>
666666

667667
<script>prettyPrint();</script>

docs/rest2.js.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1494,6 +1494,7 @@ <h1 class="page-title">rest2.js</h1>
14941494
* @param {string} params.attachments - Base64 encoded list of strings
14951495
* @param {Function} [cb] - callback
14961496
* @returns {Promise} p
1497+
* @see https://docs.bitfinex.com/reference#rest-auth-pulse-add
14971498
*/
14981499
addPulse (params, cb) {
14991500
return this._makeAuthRequest('/auth/w/pulse/add', params, cb, PulseMessage)
@@ -1539,7 +1540,7 @@ <h1 class="page-title">rest2.js</h1>
15391540
<br class="clear">
15401541

15411542
<footer>
1542-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:03:43 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1543+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Wed May 20 2020 17:04:33 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
15431544
</footer>
15441545

15451546
<script>prettyPrint();</script>

lib/rest2.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1448,6 +1448,7 @@ class RESTv2 {
14481448
* @param {string} params.attachments - Base64 encoded list of strings
14491449
* @param {Function} [cb] - callback
14501450
* @returns {Promise} p
1451+
* @see https://docs.bitfinex.com/reference#rest-auth-pulse-add
14511452
*/
14521453
addPulse (params, cb) {
14531454
return this._makeAuthRequest('/auth/w/pulse/add', params, cb, PulseMessage)

0 commit comments

Comments
 (0)