Skip to content
This repository was archived by the owner on Sep 30, 2023. It is now read-only.

Commit 07dad70

Browse files
aphelionzaphelionz
committed
Adding Entry class to docs
1 parent 890af32 commit 07dad70

File tree

13 files changed

+2186
-68
lines changed

13 files changed

+2186
-68
lines changed

‎docs/Entry.html

Lines changed: 2118 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/GSet.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
165165
<br class="clear">
166166

167167
<footer>
168-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
168+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
169169
</footer>
170170

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

‎docs/Log.html

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ <h1 class="page-title">Class: Log</h1>
3030

3131
<h2><span class="attribs"><span class="type-signature"></span></span>Log<span class="signature">(ipfs, identity, options)</span><span class="type-signature"> &rarr; {<a href="Log.html">Log</a>}</span></h2>
3232

33-
<div class="class-description">Log.</div>
34-
3533

3634
</header>
3735

@@ -41,8 +39,6 @@ <h2><span class="attribs"><span class="type-signature"></span></span>Log<span cl
4139

4240

4341

44-
<h2>Constructor</h2>
45-
4642

4743

4844
<h4 class="name" id="Log"><span class="type-signature"></span>new Log<span class="signature">(ipfs, identity, options)</span><span class="type-signature"> &rarr; {<a href="Log.html">Log</a>}</span></h4>
@@ -360,7 +356,7 @@ <h6>Properties</h6>
360356

361357
<dt class="tag-source">Source:</dt>
362358
<dd class="tag-source"><ul class="dummy"><li>
363-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line34">line 34</a>
359+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line32">line 32</a>
364360
</li></ul></dd>
365361

366362

@@ -476,7 +472,7 @@ <h4 class="name" id="clock"><span class="type-signature"></span>clock<span class
476472

477473
<dt class="tag-source">Source:</dt>
478474
<dd class="tag-source"><ul class="dummy"><li>
479-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line124">line 124</a>
475+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line122">line 122</a>
480476
</li></ul></dd>
481477

482478

@@ -538,7 +534,7 @@ <h4 class="name" id="heads"><span class="type-signature"></span>heads<span class
538534

539535
<dt class="tag-source">Source:</dt>
540536
<dd class="tag-source"><ul class="dummy"><li>
541-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line148">line 148</a>
537+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line146">line 146</a>
542538
</li></ul></dd>
543539

544540

@@ -600,7 +596,7 @@ <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type
600596

601597
<dt class="tag-source">Source:</dt>
602598
<dd class="tag-source"><ul class="dummy"><li>
603-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line116">line 116</a>
599+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line114">line 114</a>
604600
</li></ul></dd>
605601

606602

@@ -662,7 +658,7 @@ <h4 class="name" id="length"><span class="type-signature"></span>length<span cla
662658

663659
<dt class="tag-source">Source:</dt>
664660
<dd class="tag-source"><ul class="dummy"><li>
665-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line132">line 132</a>
661+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line130">line 130</a>
666662
</li></ul></dd>
667663

668664

@@ -725,7 +721,7 @@ <h4 class="name" id="tailHashes"><span class="type-signature"></span>tailHashes<
725721

726722
<dt class="tag-source">Source:</dt>
727723
<dd class="tag-source"><ul class="dummy"><li>
728-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line166">line 166</a>
724+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line164">line 164</a>
729725
</li></ul></dd>
730726

731727

@@ -788,7 +784,7 @@ <h4 class="name" id="tails"><span class="type-signature"></span>tails<span class
788784

789785
<dt class="tag-source">Source:</dt>
790786
<dd class="tag-source"><ul class="dummy"><li>
791-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line157">line 157</a>
787+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line155">line 155</a>
792788
</li></ul></dd>
793789

794790

@@ -850,7 +846,7 @@ <h4 class="name" id="values"><span class="type-signature"></span>values<span cla
850846

851847
<dt class="tag-source">Source:</dt>
852848
<dd class="tag-source"><ul class="dummy"><li>
853-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line140">line 140</a>
849+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line138">line 138</a>
854850
</li></ul></dd>
855851

856852

@@ -982,7 +978,7 @@ <h5>Parameters:</h5>
982978

983979
<dt class="tag-source">Source:</dt>
984980
<dd class="tag-source"><ul class="dummy"><li>
985-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line631">line 631</a>
981+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line629">line 629</a>
986982
</li></ul></dd>
987983

988984

@@ -1394,7 +1390,7 @@ <h6>Properties</h6>
13941390

13951391
<dt class="tag-source">Source:</dt>
13961392
<dd class="tag-source"><ul class="dummy"><li>
1397-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line614">line 614</a>
1393+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line612">line 612</a>
13981394
</li></ul></dd>
13991395

14001396

@@ -1786,7 +1782,7 @@ <h6>Properties</h6>
17861782

17871783
<dt class="tag-source">Source:</dt>
17881784
<dd class="tag-source"><ul class="dummy"><li>
1789-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line573">line 573</a>
1785+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line571">line 571</a>
17901786
</li></ul></dd>
17911787

17921788

@@ -2168,7 +2164,7 @@ <h6>Properties</h6>
21682164

21692165
<dt class="tag-source">Source:</dt>
21702166
<dd class="tag-source"><ul class="dummy"><li>
2171-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line593">line 593</a>
2167+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line591">line 591</a>
21722168
</li></ul></dd>
21732169

21742170

@@ -2537,7 +2533,7 @@ <h6>Properties</h6>
25372533

25382534
<dt class="tag-source">Source:</dt>
25392535
<dd class="tag-source"><ul class="dummy"><li>
2540-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line551">line 551</a>
2536+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line549">line 549</a>
25412537
</li></ul></dd>
25422538

25432539

@@ -2692,7 +2688,7 @@ <h5>Parameters:</h5>
26922688

26932689
<dt class="tag-source">Source:</dt>
26942690
<dd class="tag-source"><ul class="dummy"><li>
2695-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line524">line 524</a>
2691+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line522">line 522</a>
26962692
</li></ul></dd>
26972693

26982694

@@ -2847,7 +2843,7 @@ <h5>Parameters:</h5>
28472843

28482844
<dt class="tag-source">Source:</dt>
28492845
<dd class="tag-source"><ul class="dummy"><li>
2850-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line261">line 261</a>
2846+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line259">line 259</a>
28512847
</li></ul></dd>
28522848

28532849

@@ -3018,7 +3014,7 @@ <h5>Parameters:</h5>
30183014

30193015
<dt class="tag-source">Source:</dt>
30203016
<dd class="tag-source"><ul class="dummy"><li>
3021-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line186">line 186</a>
3017+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line184">line 184</a>
30223018
</li></ul></dd>
30233019

30243020

@@ -3176,7 +3172,7 @@ <h5>Parameters:</h5>
31763172

31773173
<dt class="tag-source">Source:</dt>
31783174
<dd class="tag-source"><ul class="dummy"><li>
3179-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line195">line 195</a>
3175+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line193">line 193</a>
31803176
</li></ul></dd>
31813177

31823178

@@ -3388,7 +3384,7 @@ <h5>Parameters:</h5>
33883384

33893385
<dt class="tag-source">Source:</dt>
33903386
<dd class="tag-source"><ul class="dummy"><li>
3391-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line392">line 392</a>
3387+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line390">line 390</a>
33923388
</li></ul></dd>
33933389

33943390

@@ -3564,7 +3560,7 @@ <h5>Parameters:</h5>
35643560

35653561
<dt class="tag-source">Source:</dt>
35663562
<dd class="tag-source"><ul class="dummy"><li>
3567-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line174">line 174</a>
3563+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line172">line 172</a>
35683564
</li></ul></dd>
35693565

35703566

@@ -3652,7 +3648,7 @@ <h4 class="name" id="toBuffer"><span class="type-signature"></span>toBuffer<span
36523648

36533649
<dt class="tag-source">Source:</dt>
36543650
<dd class="tag-source"><ul class="dummy"><li>
3655-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line491">line 491</a>
3651+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line489">line 489</a>
36563652
</li></ul></dd>
36573653

36583654

@@ -3758,7 +3754,7 @@ <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span cla
37583754

37593755
<dt class="tag-source">Source:</dt>
37603756
<dd class="tag-source"><ul class="dummy"><li>
3761-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line465">line 465</a>
3757+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line463">line 463</a>
37623758
</li></ul></dd>
37633759

37643760

@@ -3868,7 +3864,7 @@ <h4 class="name" id="toMultihash"><span class="type-signature"></span>toMultihas
38683864

38693865
<dt class="tag-source">Source:</dt>
38703866
<dd class="tag-source"><ul class="dummy"><li>
3871-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line534">line 534</a>
3867+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line532">line 532</a>
38723868
</li></ul></dd>
38733869

38743870

@@ -3978,7 +3974,7 @@ <h4 class="name" id="toSnapshot"><span class="type-signature"></span>toSnapshot<
39783974

39793975
<dt class="tag-source">Source:</dt>
39803976
<dd class="tag-source"><ul class="dummy"><li>
3981-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line479">line 479</a>
3977+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line477">line 477</a>
39823978
</li></ul></dd>
39833979

39843980

@@ -4088,7 +4084,7 @@ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span
40884084

40894085
<dt class="tag-source">Source:</dt>
40904086
<dd class="tag-source"><ul class="dummy"><li>
4091-
<a href="log.js.html">log.js</a>, <a href="log.js.html#line503">line 503</a>
4087+
<a href="log.js.html">log.js</a>, <a href="log.js.html#line501">line 501</a>
40924088
</li></ul></dd>
40934089

40944090

@@ -4165,7 +4161,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
41654161
<br class="clear">
41664162

41674163
<footer>
4168-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
4164+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
41694165
</footer>
41704166

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

‎docs/entry-io.js.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ <h1 class="page-title">Source: entry-io.js</h1>
111111
// not get stuck loading a block that is unreachable
112112
const timer = timeout &amp;&amp; timeout > 0
113113
? setTimeout(() => {
114-
console.warn(`Warning: Couldn't fetch entry '${hash}', request timed out (${timeout}ms)`)
115-
resolve()
116-
}, timeout)
114+
console.warn(`Warning: Couldn't fetch entry '${hash}', request timed out (${timeout}ms)`)
115+
resolve()
116+
}, timeout)
117117
: null
118118

119119
const addToResults = (entry) => {
@@ -222,7 +222,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
222222
<br class="clear">
223223

224224
<footer>
225-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
225+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
226226
</footer>
227227

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

‎docs/entry.js.html

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ <h1 class="page-title">Source: entry.js</h1>
3636
const getWriteFormatForVersion = v => v === 0 ? 'dag-pb' : 'dag-cbor'
3737
const getWriteFormat = e => Entry.isEntry(e) ? getWriteFormatForVersion(e.v) : getWriteFormatForVersion(e)
3838

39+
/*
40+
* @description
41+
* An ipfs-log entry
42+
*/
3943
class Entry {
4044
/**
4145
* Create an Entry
@@ -200,7 +204,7 @@ <h1 class="page-title">Source: entry.js</h1>
200204
* @returns {number} 1 if a is greater, -1 is b is greater
201205
*/
202206
static compare (a, b) {
203-
var distance = Clock.compare(a.clock, b.clock)
207+
const distance = Clock.compare(a.clock, b.clock)
204208
if (distance === 0) return a.clock.id &lt; b.clock.id ? -1 : 1
205209
return distance
206210
}
@@ -233,9 +237,9 @@ <h1 class="page-title">Source: entry.js</h1>
233237
* @returns {Array&lt;Entry>}
234238
*/
235239
static findChildren (entry, values) {
236-
var stack = []
237-
var parent = values.find((e) => Entry.isParent(entry, e))
238-
var prev = entry
240+
let stack = []
241+
let parent = values.find((e) => Entry.isParent(entry, e))
242+
let prev = entry
239243
while (parent) {
240244
stack.push(parent)
241245
prev = parent
@@ -265,7 +269,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
265269
<br class="clear">
266270

267271
<footer>
268-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
272+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
269273
</footer>
270274

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

‎docs/g-set.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
6262
<br class="clear">
6363

6464
<footer>
65-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
65+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
6666
</footer>
6767

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

‎docs/global.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1097,7 +1097,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
10971097
<br class="clear">
10981098

10991099
<footer>
1100-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
1100+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
11011101
</footer>
11021102

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

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
235235
<br class="clear">
236236

237237
<footer>
238-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
238+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
239239
</footer>
240240

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

‎docs/log-io.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h1 class="page-title">Source: log-io.js</h1>
177177
const missingSourceEntries = difference(sliced, sourceEntries, 'hash')
178178

179179
const replaceInFront = (a, withEntries) => {
180-
var sliced = a.slice(withEntries.length, a.length)
180+
const sliced = a.slice(withEntries.length, a.length)
181181
return withEntries.concat(sliced)
182182
}
183183

@@ -206,7 +206,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
206206
<br class="clear">
207207

208208
<footer>
209-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
209+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
210210
</footer>
211211

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

‎docs/log-sorting.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
141141
<br class="clear">
142142

143143
<footer>
144-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 14:01:03 GMT-0500 (Eastern Standard Time)
144+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 11 2020 17:11:17 GMT-0500 (Eastern Standard Time)
145145
</footer>
146146

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

0 commit comments

Comments
 (0)