Skip to content

Commit

Permalink
Update docs for 1.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@dolencd
dolencd committed Sep 7, 2021
1 parent eb26a9e commit 0ec6c59
Show file tree
Hide file tree
Showing 11 changed files with 157 additions and 135 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

44 changes: 22 additions & 22 deletions docs/classes/libbot.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L117">src/libBot.ts:117</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L117">src/libBot.ts:117</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -163,7 +163,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> in<wbr>Transition</h3>
<div class="tsd-signature tsd-kind-icon">in<wbr>Transition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L80">src/libBot.ts:80</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L80">src/libBot.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -178,7 +178,7 @@ <h3>max<wbr>Emitted<wbr>Seq</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Emitted<wbr>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L115">src/libBot.ts:115</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L115">src/libBot.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -193,7 +193,7 @@ <h3>max<wbr>Inc<wbr>Seq</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Inc<wbr>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L95">src/libBot.ts:95</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L95">src/libBot.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -208,7 +208,7 @@ <h3>max<wbr>Send<wbr>Ack</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Send<wbr>Ack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L110">src/libBot.ts:110</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L110">src/libBot.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -223,7 +223,7 @@ <h3>max<wbr>Send<wbr>Ack<wbr>Known<wbr>Received</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Send<wbr>Ack<wbr>Known<wbr>Received<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L100">src/libBot.ts:100</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L100">src/libBot.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -238,7 +238,7 @@ <h3>max<wbr>Send<wbr>Seq</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Send<wbr>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L105">src/libBot.ts:105</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L105">src/libBot.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -253,7 +253,7 @@ <h3>max<wbr>Send<wbr>Seq<wbr>Known<wbr>Received</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Send<wbr>Seq<wbr>Known<wbr>Received<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L90">src/libBot.ts:90</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L90">src/libBot.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -268,7 +268,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LibBotOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L59">src/libBot.ts:59</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L59">src/libBot.ts:59</a></li>
</ul>
</aside>
</section>
Expand All @@ -278,7 +278,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> rec<wbr>Seq<wbr>Offset<
<div class="tsd-signature tsd-kind-icon">rec<wbr>Seq<wbr>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L117">src/libBot.ts:117</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L117">src/libBot.ts:117</a></li>
</ul>
</aside>
</section>
Expand All @@ -288,7 +288,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">received<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L64">src/libBot.ts:64</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L64">src/libBot.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -303,7 +303,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">send<wbr>Fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L85">src/libBot.ts:85</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L85">src/libBot.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -318,7 +318,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
<div class="tsd-signature tsd-kind-icon">sent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>buf<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>maxAck<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L69">src/libBot.ts:69</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L69">src/libBot.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -340,7 +340,7 @@ <h3>failed<wbr>Receive<wbr>Message<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L170">src/libBot.ts:170</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L170">src/libBot.ts:170</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -362,7 +362,7 @@ <h3>failed<wbr>Send<wbr>Message<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L163">src/libBot.ts:163</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L163">src/libBot.ts:163</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -384,7 +384,7 @@ <h3>unacked<wbr>Message<wbr>Count</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L177">src/libBot.ts:177</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L177">src/libBot.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -409,7 +409,7 @@ <h3>get<wbr>Acks</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L245">src/libBot.ts:245</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L245">src/libBot.ts:245</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -437,7 +437,7 @@ <h3>get<wbr>Lib<wbr>State</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L156">src/libBot.ts:156</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L156">src/libBot.ts:156</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -454,7 +454,7 @@ <h3>receive<wbr>Message</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L269">src/libBot.ts:269</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L269">src/libBot.ts:269</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -488,7 +488,7 @@ <h3>send</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L187">src/libBot.ts:187</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L187">src/libBot.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -522,7 +522,7 @@ <h3>send<wbr>Acks</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L235">src/libBot.ts:235</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L235">src/libBot.ts:235</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -550,7 +550,7 @@ <h3>send<wbr>Failed<wbr>Messages</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/6c94f2b/src/libBot.ts#L215">src/libBot.ts:215</a></li>
<li>Defined in <a href="https://github.com/dolencd/protocol//blob/5d3471a/src/libBot.ts#L215">src/libBot.ts:215</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 0ec6c59

Please sign in to comment.