mirror of https://github.com/waku-org/js-waku.git
59 lines
8.7 KiB
HTML
59 lines
8.7 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>js-waku</title><meta name="description" content="Documentation for js-waku"/><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">js-waku</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><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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"><h1>js-waku</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p><a href="https://npmjs.org/package/js-waku"><img src="https://nodei.co/npm/js-waku.png" alt="NPM"></a></p>
|
|
<p><img src="https://img.shields.io/github/workflow/status/status-im/js-waku/CI" alt="GitHub Action">
|
|
<a href="https://discord.gg/j5pGbn7MHZ"><img src="https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA" alt="Discord chat"></a></p>
|
|
|
|
<a href="#js-waku" id="js-waku" style="color: inherit; text-decoration: none;">
|
|
<h1>js-waku</h1>
|
|
</a>
|
|
<p>A JavaScript implementation of the <a href="https://rfc.vac.dev/spec/10/">Waku v2 protocol</a>.</p>
|
|
|
|
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
|
|
<h2>Documentation</h2>
|
|
</a>
|
|
<ul>
|
|
<li><a href="https://docs.wakuconnect.dev/docs/quick_start/">Quick start</a></li>
|
|
<li><a href="https://docs.wakuconnect.dev/">Full documentation</a></li>
|
|
<li><a href="https://js-waku.wakuconnect.dev/">API documentation (<code>master</code> branch)</a></li>
|
|
<li><a href="https://wakuconnect.dev/">Waku Connect</a></li>
|
|
<li><a href="https://wakunetwork.com/">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 clone https://github.com/status-im/js-waku.git</span><br/><span class="hl-1">cd</span><span class="hl-0"> js-waku</span><br/><span class="hl-0">npm install</span><br/><span class="hl-0">npm run doc</span>
|
|
</code></pre>
|
|
|
|
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
|
<h2>Changelog</h2>
|
|
</a>
|
|
<p>Release changelog can be found in <a href="https://github.com/status-im/js-waku/blob/master/CHANGELOG.md">CHANGELOG.md</a>.</p>
|
|
|
|
<a href="#bugs-questions-amp-features" id="bugs-questions-amp-features" style="color: inherit; text-decoration: none;">
|
|
<h2>Bugs, Questions & Features</h2>
|
|
</a>
|
|
<p>If you encounter any bug or would like to propose new features, feel free to <a href="https://github.com/status-im/js-waku/issues/new/">open an issue</a>.</p>
|
|
<p>To get help, join <strong>#wakuconnect-support</strong> on <a href="https://discord.gg/j5pGbn7MHZ">Vac Discord</a> or <a href="https://t.me/wakuconnectsupport">Telegram</a>.</p>
|
|
<p>For more general discussion and latest news, join <strong>#wakuconnect</strong> on <a href="https://discord.gg/9DgykdmpZ6">Vac Discord</a> or <a href="https://t.me/wakuconnect">Telegram</a>.</p>
|
|
|
|
<a href="#roadmap" id="roadmap" style="color: inherit; text-decoration: none;">
|
|
<h2>Roadmap</h2>
|
|
</a>
|
|
<p>You can track progress on the <a href="https://github.com/status-im/js-waku/projects/1">project board</a>.</p>
|
|
|
|
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
|
|
<h2>Contributing</h2>
|
|
</a>
|
|
<p>See <a href="https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
|
|
|
|
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
|
|
<h2>License</h2>
|
|
</a>
|
|
<p>Licensed and distributed under either of</p>
|
|
<ul>
|
|
<li>MIT license: <a href="https://github.com/status-im/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/status-im/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-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="modules/utf8.html">utf8</a></li><li class=" tsd-kind-namespace"><a href="modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference"><a href="modules.html#DefaultPubSubTopic" class="tsd-kind-icon">Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-reference"><a href="modules.html#LightPushCodec" class="tsd-kind-icon">Light<wbr/>Push<wbr/>Codec</a></li><li class="tsd-kind-reference"><a href="modules.html#PageDirection" class="tsd-kind-icon">Page<wbr/>Direction</a></li><li class="tsd-kind-reference"><a href="modules.html#PushResponse" class="tsd-kind-icon">Push<wbr/>Response</a></li><li class="tsd-kind-reference"><a href="modules.html#RelayCodecs" class="tsd-kind-icon">Relay<wbr/>Codecs</a></li><li class="tsd-kind-reference"><a href="modules.html#StoreCodecs" class="tsd-kind-icon">Store<wbr/>Codecs</a></li><li class="tsd-kind-reference"><a href="modules.html#Waku" class="tsd-kind-icon">Waku</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuLightPush" class="tsd-kind-icon">Waku<wbr/>Light<wbr/>Push</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuMessage" class="tsd-kind-icon">Waku<wbr/>Message</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuRelay" class="tsd-kind-icon">Waku<wbr/>Relay</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuStore" class="tsd-kind-icon">Waku<wbr/>Store</a></li><li class="tsd-kind-function"><a href="modules.html#generatePrivateKey" class="tsd-kind-icon">generate<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-function"><a href="modules.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-function"><a href="modules.html#getPredefinedBootstrapNodes" class="tsd-kind-icon">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes</a></li><li class="tsd-kind-function"><a href="modules.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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> |