2023-11-28 15:58:49 +00:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>utils | 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/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"</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="#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="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Documentation</a></li><li><a href="_waku_sdk.html">@waku/sdk</a></li><li><a href="_waku_sdk.utils.html">utils</a></li></ul><h1>Namespace utils</h1></div><aside class="tsd-sources"><ul><li>Defined in packages/utils/dist/index.d.ts:1</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_waku_sdk.utils.Logger.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Logger</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_waku_sdk.utils.IteratorOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Iterator<wbr/>Options</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_waku_sdk.utils.contentTopicToPubsubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>content<wbr/>Topic<wbr/>To<wbr/>Pubsub<wbr/>Topic</span></a>
|
2023-11-16 22:20:53 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.contentTopicToShardIndex.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>content<wbr/>Topic<wbr/>To<wbr/>Shard<wbr/>Index</span></a>
|
2023-12-21 18:45:51 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.contentTopicsByPubsubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>content<wbr/>Topics<wbr/>By<wbr/>Pubsub<wbr/>Topic</span></a>
|
2024-01-19 15:14:39 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.decodeRelayShard.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decode<wbr/>Relay<wbr/>Shard</span></a>
|
2023-12-21 18:45:51 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.determinePubsubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>determine<wbr/>Pubsub<wbr/>Topic</span></a>
|
2024-01-19 15:14:39 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.encodeRelayShard.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>Relay<wbr/>Shard</span></a>
|
2023-11-16 22:20:53 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.ensurePubsubTopicIsConfigured.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ensure<wbr/>Pubsub<wbr/>Topic<wbr/>Is<wbr/>Configured</span></a>
|
2024-01-24 16:35:05 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.ensureShardingConfigured.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ensure<wbr/>Sharding<wbr/>Configured</span></a>
|
2023-11-16 06:46:02 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.ensureValidContentTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ensure<wbr/>Valid<wbr/>Content<wbr/>Topic</span></a>
|
2023-09-27 10:05:48 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.getPseudoRandomSubset.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Pseudo<wbr/>Random<wbr/>Subset</span></a>
|
2024-02-16 14:37:52 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.getWsMultiaddrFromMultiaddrs.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Ws<wbr/>Multiaddr<wbr/>From<wbr/>Multiaddrs</span></a>
|
2023-09-21 08:59:21 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.groupByContentTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>group<wbr/>By<wbr/>Content<wbr/>Topic</span></a>
|
|
|
|
|
<a href="../functions/_waku_sdk.utils.isDefined.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Defined</span></a>
|
2023-10-26 11:16:42 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.isMessageSizeUnderCap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Message<wbr/>Size<wbr/>Under<wbr/>Cap</span></a>
|
|
|
|
|
<a href="../functions/_waku_sdk.utils.isWireSizeUnderCap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Wire<wbr/>Size<wbr/>Under<wbr/>Cap</span></a>
|
2023-11-28 10:29:33 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.pubsubTopicToSingleShardInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>pubsub<wbr/>Topic<wbr/>To<wbr/>Single<wbr/>Shard<wbr/>Info</span></a>
|
2023-09-27 10:05:48 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.pushOrInitMapSet.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>push<wbr/>Or<wbr/>Init<wbr/>Map<wbr/>Set</span></a>
|
2023-09-21 08:59:21 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.removeItemFromArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>remove<wbr/>Item<wbr/>From<wbr/>Array</span></a>
|
2023-11-14 15:55:04 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.shardInfoToPubsubTopics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>shard<wbr/>Info<wbr/>To<wbr/>Pubsub<wbr/>Topics</span></a>
|
2023-11-28 10:29:33 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.singleShardInfoToPubsubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>single<wbr/>Shard<wbr/>Info<wbr/>To<wbr/>Pubsub<wbr/>Topic</span></a>
|
2024-01-19 15:14:39 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.singleShardInfosToShardInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>single<wbr/>Shard<wbr/>Infos<wbr/>To<wbr/>Shard<wbr/>Info</span></a>
|
2023-09-21 08:59:21 +00:00
|
|
|
<a href="../functions/_waku_sdk.utils.toAsyncIterator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>to<wbr/>Async<wbr/>Iterator</span></a>
|
2024-04-02 11:54:35 +00:00
|
|
|
</div></section></section></section></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="#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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><details class="tsd-index-accordion" data-key="@waku"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>@waku</span></summary><div class="tsd-accordion-details"><ul class="tsd-nested-navigation"><li><a href="_waku_proto.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>proto</a></li><li><a href="_waku_interfaces.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>interfaces</a></li><li><a href="_waku_utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>utils</a></li><li><a href="_waku_message_hash.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>message-hash</a></li><li><a href="_waku_enr.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>enr</a></li><li><a href="_waku_core.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>core</a></li><li><a href="_waku_relay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>relay</a></li><li><a href="_waku_discovery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>discovery</a></li><li><a href="_waku_message_encryption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>message-encryption</a></li><li><a href="_waku_sdk.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>sdk</a></li><li><a href="_waku_browser_tests.html
|
