mirror of https://github.com/waku-org/js-waku.git
28 lines
8.5 KiB
HTML
28 lines
8.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>Documentation</title><meta name="description" content="Documentation for Documentation"/><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">Documentation</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>Documentation</h2></div><div class="tsd-panel tsd-typography"><p><img src="https://img.shields.io/github/actions/workflow/status/waku-org/js-waku/ci.yml?branch=master" alt="GitHub Action">
|
|
<img src="https://img.shields.io/codeclimate/maintainability/waku-org/js-waku" alt="Code Climate">
|
|
<a href="https://discord.waku.org"><img src="https://img.shields.io/discord/1110799176264056863.svg?logo=discord&colorB=7289DA" alt="Discord chat"></a></p>
|
|
<a id="md:js-waku" class="tsd-anchor"></a><h1><a href="#md:js-waku">js-waku</a></h1><p>A TypeScript implementation of the <a href="https://rfc.vac.dev/spec/10/">Waku v2 protocol</a>.</p>
|
|
<a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><ul>
|
|
<li><a href="https://docs.waku.org/guides/js-waku/#getting-started">Quick start</a></li>
|
|
<li><a href="https://docs.waku.org/guides/js-waku">Full documentation</a></li>
|
|
<li><a href="https://js.waku.org/">API documentation (<code>master</code> branch)</a></li>
|
|
<li><a href="https://waku.org/">Waku</a></li>
|
|
<li><a href="https://vac.dev/">Vac</a></li>
|
|
</ul>
|
|
<p>API Documentation can also be generated locally:</p>
|
|
<pre><code class="language-shell"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://github.com/waku-org/js-waku.git</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">js-waku</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">doc</span>
|
|
</code><button>Copy</button></pre>
|
|
<a id="md:bugs-questions-amp-features" class="tsd-anchor"></a><h2><a href="#md:bugs-questions-amp-features">Bugs, Questions & Features</a></h2><p>If you encounter any bug or would like to propose new features, feel free to <a href="https://github.com/waku-org/js-waku/issues/new/">open an issue</a>.</p>
|
|
<p>For general discussion, get help or latest news, join us on <a href="https://discord.gg/Nrac59MfSX">Vac Discord</a> or the <a href="https://t.me/waku_org">Waku Telegram Group</a>.</p>
|
|
<a id="md:roadmap" class="tsd-anchor"></a><h2><a href="#md:roadmap">Roadmap</a></h2><p>You can track progress on the <a href="https://github.com/orgs/waku-org/projects/2/views/1">project board</a>.</p>
|
|
<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><p>See <a href="https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
|
|
<a id="md:license" class="tsd-anchor"></a><h2><a href="#md:license">License</a></h2><p>Licensed and distributed under either of</p>
|
|
<ul>
|
|
<li>MIT license: <a href="https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT">LICENSE-MIT</a> or <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></li>
|
|
</ul>
|
|
<p>or</p>
|
|
<ul>
|
|
<li>Apache License, Version 2.0, (<a href="https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2">LICENSE-APACHE-v2</a> or <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>)</li>
|
|
</ul>
|
|
<p>at your option. These files may not be copied, modified, or distributed except according to those terms.</p>
|
|
</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></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:js-waku"><span>js-<wbr/>waku</span></a><ul><li><a href="#md:documentation"><span>Documentation</span></a></li><li><a href="#md:bugs-questions-amp-features"><span>Bugs, <wbr/>Questions & <wbr/>Features</span></a></li><li><a href="#md:roadmap"><span>Roadmap</span></a></li><li><a href="#md:contributing"><span>Contributing</span></a></li><li><a href="#md:license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Documentation</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> |