mirror of
https://github.com/stjet/bns.git
synced 2025-12-29 11:19:25 +00:00
10 lines
9.5 KiB
HTML
10 lines
9.5 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>bns</title><meta name="description" content="Documentation for bns"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">bns</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>bns</h2></div><div class="tsd-panel tsd-typography"><p>See the <a href="bns_protocol.md">protocol specification</a>, <a href="https://bns.prussia.dev">docs</a> or <a href="https://bns.prussia.dev/browser_test">demo</a></p>
|
|
<a id="md:installing" class="tsd-anchor"></a><h2><a href="#md:installing">Installing</a></h2><a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">NPM</a></h3><pre><code class="language-js"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">i</span><span class="hl-1"> </span><span class="hl-0">banani</span><span class="hl-1">-</span><span class="hl-0">bns</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:web" class="tsd-anchor"></a><h3><a href="#md:web">Web</a></h3><p>Add the<code>bns-browser.js</code> file in this browser to your site. Then, in your <code><head></code>, add:</p>
|
|
<pre><code class="language-html"><span class="hl-2"><</span><span class="hl-3">script</span><span class="hl-4"> </span><span class="hl-5">src</span><span class="hl-4">=</span><span class="hl-6">"/path/to/bns-browser.js"</span><span class="hl-2">></</span><span class="hl-3">script</span><span class="hl-2">></span>
|
|
</code><button>Copy</button></pre>
|
|
<p>You can now access the library through <code>window.bns</code> in your scripts.</p>
|
|
<a id="md:example" class="tsd-anchor"></a><h2><a href="#md:example">Example</a></h2><a id="md:resolving" class="tsd-anchor"></a><h3><a href="#md:resolving">Resolving</a></h3><pre><code class="language-js"><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-0">banani</span><span class="hl-1">, </span><span class="hl-0">Resolver</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-8">"banani-bns"</span><span class="hl-1">;</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">rpc</span><span class="hl-1"> = </span><span class="hl-9">new</span><span class="hl-1"> </span><span class="hl-0">banani</span><span class="hl-1">.</span><span class="hl-11">RPC</span><span class="hl-1">(</span><span class="hl-8">"https://kaliumapi.appditto.com/api"</span><span class="hl-1">);</span><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">tld_mapping</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-8">"mictest"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-8">"ban_1dzpfrgi8t4byzmdeidh57p14h5jwbursf1t3ztbmeqnqqdcbpgp9x8j3cw6"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">"jtv"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-8">"ban_3gipeswotbnyemcc1dejyhy5a1zfgj35kw356dommbx4rdochiteajcsay56"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">"ban"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-8">"ban_1fdo6b4bqm6pp1w55duuqw5ebz455975o4qcp8of85fjcdw9qhuzxsd3tjb9"</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">resolver</span><span class="hl-1"> = </span><span class="hl-9">new</span><span class="hl-1"> </span><span class="hl-11">Resolver</span><span class="hl-1">(</span><span class="hl-0">rpc</span><span class="hl-1">, </span><span class="hl-0">tld_mapping</span><span class="hl-1">);</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-11">log</span><span class="hl-1">(</span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-0">resolver</span><span class="hl-1">.</span><span class="hl-11">resolve</span><span class="hl-1">(</span><span class="hl-8">"nishina247"</span><span class="hl-1">, </span><span class="hl-8">"mictest"</span><span class="hl-1">));</span>
|
|
</code><button>Copy</button></pre>
|
|
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:installing"><span>Installing</span></a><ul><li><a href="#md:npm"><span>NPM</span></a></li><li><a href="#md:web"><span>Web</span></a></li></ul><a href="#md:example"><span>Example</span></a><ul><li><a href="#md:resolving"><span>Resolving</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>bns</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |