Skip to content

Commit a9a51c3

Browse files
XzFirzalXzFirzal
committed
docs: Rebuilt docs
1 parent 7c29a79 commit a9a51c3

File tree

90 files changed

+317
-283
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+317
-283
lines changed

Diff for: ‎docs/assets/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/classes/CoffeeLava.html

+12-10
Large diffs are not rendered by default.

Diff for: ‎docs/classes/CoffeeNode.html

+17-13
Large diffs are not rendered by default.

Diff for: ‎docs/classes/CoffeePlayer.html

+28-28
Large diffs are not rendered by default.

Diff for: ‎docs/classes/CoffeeQueue.html

+10-10
Large diffs are not rendered by default.

Diff for: ‎docs/classes/CoffeeRoutePlanner.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CoffeeRoutePlanner | lavacoffee</title><meta name="description" content="Documentation for lavacoffee"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">lavacoffee</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">lavacoffee</a></li><li><a href="CoffeeRoutePlanner.html">CoffeeRoutePlanner</a></li></ul><h1>Class CoffeeRoutePlanner</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CoffeeRoutePlanner</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#node" class="tsd-kind-icon">node</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#freeAddress" class="tsd-kind-icon">free<wbr/>Address</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#freeAllAddress" class="tsd-kind-icon">free<wbr/>All<wbr/>Address</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#status" class="tsd-kind-icon">status</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Coffee<wbr/>Route<wbr/>Planner<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="CoffeeNode.html" class="tsd-signature-type" data-tsd-kind="Class">CoffeeNode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CoffeeRoutePlanner.html" class="tsd-signature-type" data-tsd-kind="Class">CoffeeRoutePlanner</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/7c29a79/src/structures/CoffeeRoutePlanner.ts#L7">src/structures/CoffeeRoutePlanner.ts:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>node: <a href="CoffeeNode.html" class="tsd-signature-type" data-tsd-kind="Class">CoffeeNode</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CoffeeRoutePlanner.html" class="tsd-signature-type" data-tsd-kind="Class">CoffeeRoutePlanner</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="node" class="tsd-anchor"></a><h3>node</h3><div class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">:</span> <a href="CoffeeNode.html" class="tsd-signature-type" data-tsd-kind="Class">CoffeeNode</a></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="freeAddress" class="tsd-anchor"></a><h3>free<wbr/>Address</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">free<wbr/>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/7c29a79/src/structures/CoffeeRoutePlanner.ts#L25">src/structures/CoffeeRoutePlanner.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2+
<p>Unmark a failed address</p>
3+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>address: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="freeAllAddress" class="tsd-anchor"></a><h3>free<wbr/>All<wbr/>Address</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">free<wbr/>All<wbr/>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/7c29a79/src/structures/CoffeeRoutePlanner.ts#L36">src/structures/CoffeeRoutePlanner.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4+
<p>Unmark all failed address</p>
5+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="status" class="tsd-anchor"></a><h3>status</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/Utils.html#RoutePlanners" class="tsd-signature-type" data-tsd-kind="Type alias">RoutePlanners</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XzFirzal/lavacoffee/blob/7c29a79/src/structures/CoffeeRoutePlanner.ts#L12">src/structures/CoffeeRoutePlanner.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6+
<p>Get the routePlanner status</p>
7+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/Utils.html#RoutePlanners" class="tsd-signature-type" data-tsd-kind="Type alias">RoutePlanners</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/Utils.html">Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CoffeeRoutePlanner.html" class="tsd-kind-icon">Coffee<wbr/>Route<wbr/>Planner</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#node" class="tsd-kind-icon">node</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#freeAddress" class="tsd-kind-icon">free<wbr/>Address</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#freeAllAddress" class="tsd-kind-icon">free<wbr/>All<wbr/>Address</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CoffeeRoutePlanner.html#status" class="tsd-kind-icon">status</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)