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

Commit

Permalink
Adding Entry class to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aphelionz
aphelionz committed Dec 11, 2020
1 parent 890af32 commit 07dad70
Show file tree
Hide file tree
Showing 13 changed files with 2,186 additions and 68 deletions.
2,118 changes: 2,118 additions & 0 deletions docs/Entry.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/GSet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
54 changes: 25 additions & 29 deletions docs/Log.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ <h1 class="page-title">Class: Log</h1>

<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>

<div class="class-description">Log.</div>


</header>

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



<h2>Constructor</h2>



<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>
Expand Down Expand Up @@ -360,7 +356,7 @@ <h6>Properties</h6>

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


Expand Down Expand Up @@ -982,7 +978,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -1394,7 +1390,7 @@ <h6>Properties</h6>

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


Expand Down Expand Up @@ -1786,7 +1782,7 @@ <h6>Properties</h6>

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


Expand Down Expand Up @@ -2168,7 +2164,7 @@ <h6>Properties</h6>

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


Expand Down Expand Up @@ -2537,7 +2533,7 @@ <h6>Properties</h6>

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


Expand Down Expand Up @@ -2692,7 +2688,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -2847,7 +2843,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3018,7 +3014,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3176,7 +3172,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3388,7 +3384,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3564,7 +3560,7 @@ <h5>Parameters:</h5>

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


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

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


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

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


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

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


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

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


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

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


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

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
8 changes: 4 additions & 4 deletions docs/entry-io.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ <h1 class="page-title">Source: entry-io.js</h1>
// not get stuck loading a block that is unreachable
const timer = timeout &amp;&amp; timeout > 0
? setTimeout(() => {
console.warn(`Warning: Couldn't fetch entry '${hash}', request timed out (${timeout}ms)`)
resolve()
}, timeout)
console.warn(`Warning: Couldn't fetch entry '${hash}', request timed out (${timeout}ms)`)
resolve()
}, timeout)
: null

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

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
14 changes: 9 additions & 5 deletions docs/entry.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ <h1 class="page-title">Source: entry.js</h1>
const getWriteFormatForVersion = v => v === 0 ? 'dag-pb' : 'dag-cbor'
const getWriteFormat = e => Entry.isEntry(e) ? getWriteFormatForVersion(e.v) : getWriteFormatForVersion(e)

/*
* @description
* An ipfs-log entry
*/
class Entry {
/**
* Create an Entry
Expand Down Expand Up @@ -200,7 +204,7 @@ <h1 class="page-title">Source: entry.js</h1>
* @returns {number} 1 if a is greater, -1 is b is greater
*/
static compare (a, b) {
var distance = Clock.compare(a.clock, b.clock)
const distance = Clock.compare(a.clock, b.clock)
if (distance === 0) return a.clock.id &lt; b.clock.id ? -1 : 1
return distance
}
Expand Down Expand Up @@ -233,9 +237,9 @@ <h1 class="page-title">Source: entry.js</h1>
* @returns {Array&lt;Entry>}
*/
static findChildren (entry, values) {
var stack = []
var parent = values.find((e) => Entry.isParent(entry, e))
var prev = entry
let stack = []
let parent = values.find((e) => Entry.isParent(entry, e))
let prev = entry
while (parent) {
stack.push(parent)
prev = parent
Expand Down Expand Up @@ -265,7 +269,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion docs/g-set.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
4 changes: 2 additions & 2 deletions docs/log-io.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h1 class="page-title">Source: log-io.js</h1>
const missingSourceEntries = difference(sliced, sourceEntries, 'hash')

const replaceInFront = (a, withEntries) => {
var sliced = a.slice(withEntries.length, a.length)
const sliced = a.slice(withEntries.length, a.length)
return withEntries.concat(sliced)
}

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

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion docs/log-sorting.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="GSet.html
<br class="clear">

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 07dad70

Please sign in to comment.