docs: update documentation [skip ci]

libp2p · Sep 12, 2024 · 1cc50f7 · 1cc50f7
1 parent 7cc534c
commit 1cc50f7
Show file tree

Hide file tree

Showing 559 changed files with 1,461 additions and 1,453 deletions.
diff --git a/assets/navigation.js b/assets/navigation.js
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/_libp2p_floodsub.FloodSub.html b/classes/_libp2p_floodsub.FloodSub.html
diff --git a/classes/_libp2p_interface.AbortError.html b/classes/_libp2p_interface.AbortError.html
diff --git a/classes/_libp2p_interface.AlreadyStartedError.html b/classes/_libp2p_interface.AlreadyStartedError.html
diff --git a/classes/_libp2p_interface.ConnectionClosedError.html b/classes/_libp2p_interface.ConnectionClosedError.html
diff --git a/classes/_libp2p_interface.ConnectionClosingError.html b/classes/_libp2p_interface.ConnectionClosingError.html
diff --git a/classes/_libp2p_interface.ConnectionFailedError.html b/classes/_libp2p_interface.ConnectionFailedError.html
diff --git a/classes/_libp2p_interface.DialError.html b/classes/_libp2p_interface.DialError.html
diff --git a/classes/_libp2p_interface.InvalidCIDError.html b/classes/_libp2p_interface.InvalidCIDError.html
diff --git a/classes/_libp2p_interface.InvalidCryptoExchangeError.html b/classes/_libp2p_interface.InvalidCryptoExchangeError.html
diff --git a/classes/_libp2p_interface.InvalidMessageError.html b/classes/_libp2p_interface.InvalidMessageError.html
diff --git a/classes/_libp2p_interface.InvalidMultiaddrError.html b/classes/_libp2p_interface.InvalidMultiaddrError.html
diff --git a/classes/_libp2p_interface.InvalidMultihashError.html b/classes/_libp2p_interface.InvalidMultihashError.html
diff --git a/classes/_libp2p_interface.InvalidParametersError.html b/classes/_libp2p_interface.InvalidParametersError.html
diff --git a/classes/_libp2p_interface.InvalidPeerIdError.html b/classes/_libp2p_interface.InvalidPeerIdError.html
diff --git a/classes/_libp2p_interface.InvalidPrivateKeyError.html b/classes/_libp2p_interface.InvalidPrivateKeyError.html
diff --git a/classes/_libp2p_interface.InvalidPublicKeyError.html b/classes/_libp2p_interface.InvalidPublicKeyError.html
diff --git a/classes/_libp2p_interface.LimitedConnectionError.html b/classes/_libp2p_interface.LimitedConnectionError.html
diff --git a/classes/_libp2p_interface.ListenError.html b/classes/_libp2p_interface.ListenError.html
diff --git a/classes/_libp2p_interface.MuxerClosedError.html b/classes/_libp2p_interface.MuxerClosedError.html
diff --git a/classes/_libp2p_interface.NotFoundError.html b/classes/_libp2p_interface.NotFoundError.html
diff --git a/classes/_libp2p_interface.NotStartedError.html b/classes/_libp2p_interface.NotStartedError.html
diff --git a/classes/_libp2p_interface.ProtocolError.html b/classes/_libp2p_interface.ProtocolError.html
diff --git a/classes/_libp2p_interface.StreamResetError.html b/classes/_libp2p_interface.StreamResetError.html
diff --git a/classes/_libp2p_interface.StreamStateError.html b/classes/_libp2p_interface.StreamStateError.html
diff --git a/classes/_libp2p_interface.TimeoutError.html b/classes/_libp2p_interface.TimeoutError.html
diff --git a/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html b/classes/_libp2p_interface.TooManyInboundProtocolStreamsError.html
diff --git a/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html b/classes/_libp2p_interface.TooManyOutboundProtocolStreamsError.html
diff --git a/classes/_libp2p_interface.TypedEventEmitter.html b/classes/_libp2p_interface.TypedEventEmitter.html
diff --git a/classes/_libp2p_interface.UnexpectedPeerError.html b/classes/_libp2p_interface.UnexpectedPeerError.html
diff --git a/classes/_libp2p_interface.UnsupportedKeyTypeError.html b/classes/_libp2p_interface.UnsupportedKeyTypeError.html
diff --git a/classes/_libp2p_interface.UnsupportedOperationError.html b/classes/_libp2p_interface.UnsupportedOperationError.html
diff --git a/classes/_libp2p_interface.UnsupportedProtocolError.html b/classes/_libp2p_interface.UnsupportedProtocolError.html
diff --git a/classes/_libp2p_peer_collections.PeerFilter.html b/classes/_libp2p_peer_collections.PeerFilter.html
diff --git a/classes/_libp2p_peer_collections.PeerList.html b/classes/_libp2p_peer_collections.PeerList.html
diff --git a/classes/_libp2p_peer_collections.PeerMap.html b/classes/_libp2p_peer_collections.PeerMap.html
diff --git a/classes/_libp2p_peer_collections.PeerSet.html b/classes/_libp2p_peer_collections.PeerSet.html
diff --git a/classes/_libp2p_peer_record.PeerRecord.html b/classes/_libp2p_peer_record.PeerRecord.html
diff --git a/classes/_libp2p_peer_record.RecordEnvelope.html b/classes/_libp2p_peer_record.RecordEnvelope.html
diff --git a/classes/_libp2p_peer_store.PersistentPeerStore.html b/classes/_libp2p_peer_store.PersistentPeerStore.html
diff --git a/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html b/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html
diff --git a/classes/_libp2p_pubsub.peer_streams.PeerStreams.html b/classes/_libp2p_pubsub.peer_streams.PeerStreams.html
diff --git a/classes/_libp2p_record.Libp2pRecord.html b/classes/_libp2p_record.Libp2pRecord.html
diff --git a/classes/_libp2p_utils.abstract_stream.AbstractStream.html b/classes/_libp2p_utils.abstract_stream.AbstractStream.html
diff --git a/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html b/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html
diff --git a/classes/_libp2p_utils.filters.BloomFilter.html b/classes/_libp2p_utils.filters.BloomFilter.html
diff --git a/classes/_libp2p_utils.filters.CuckooFilter.html b/classes/_libp2p_utils.filters.CuckooFilter.html
diff --git a/classes/_libp2p_utils.filters.ScalableCuckooFilter.html b/classes/_libp2p_utils.filters.ScalableCuckooFilter.html
diff --git a/classes/_libp2p_utils.moving_average.MovingAverage.html b/classes/_libp2p_utils.moving_average.MovingAverage.html
diff --git a/classes/_libp2p_utils.peer_queue.PeerQueue.html b/classes/_libp2p_utils.peer_queue.PeerQueue.html
diff --git a/classes/_libp2p_utils.priority_queue.PriorityQueue.html b/classes/_libp2p_utils.priority_queue.PriorityQueue.html
diff --git a/classes/_libp2p_utils.queue.Queue.html b/classes/_libp2p_utils.queue.Queue.html
diff --git a/classes/_libp2p_utils.rate_limiter.RateLimiter.html b/classes/_libp2p_utils.rate_limiter.RateLimiter.html
diff --git a/enums/_libp2p_interface.FaultTolerance.html b/enums/_libp2p_interface.FaultTolerance.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FaultTolerance | libp2p</title><meta name="description" content="Documentation for libp2p"/><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">libp2p</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"><ul class="tsd-breadcrumb"><li><a href="../index.html">libp2p</a></li><li><a href="../modules/_libp2p_interface.html">@libp2p/interface</a></li><li><a href="_libp2p_interface.FaultTolerance.html">FaultTolerance</a></li></ul><h1>Enumeration FaultTolerance</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Enum Transport Manager Fault Tolerance values</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/c435271e83382fb0bdf18ac198444ab8eacf9452/packages/interface/src/transport/index.ts#L91">packages/interface/src/transport/index.ts:91</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="_libp2p_interface.FaultTolerance.html#FATAL_ALL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL_<wbr/>ALL</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/62ce7b29e1f7b8ebdcd00c25a099fecfec335197/packages/interface/src/transport/index.ts#L91">packages/interface/src/transport/index.ts:91</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="_libp2p_interface.FaultTolerance.html#FATAL_ALL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL_<wbr/>ALL</span></a>
 <a href="_libp2p_interface.FaultTolerance.html#NO_FATAL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NO_<wbr/>FATAL</span></a>
 </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="FATAL_ALL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FATAL_<wbr/>ALL</span><a href="#FATAL_ALL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">FATAL_<wbr/>ALL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><div class="tsd-comment tsd-typography"><p>should be used for failing in any listen circumstance</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/c435271e83382fb0bdf18ac198444ab8eacf9452/packages/interface/src/transport/index.ts#L95">packages/interface/src/transport/index.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NO_FATAL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NO_<wbr/>FATAL</span><a href="#NO_FATAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NO_<wbr/>FATAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><div class="tsd-comment tsd-typography"><p>should be used for not failing when not listening</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/c435271e83382fb0bdf18ac198444ab8eacf9452/packages/interface/src/transport/index.ts#L100">packages/interface/src/transport/index.ts:100</a></li></ul></aside></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="../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="#FATAL_ALL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL_<wbr/>ALL</span></a><a href="#NO_FATAL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NO_<wbr/>FATAL</span></a></div></details></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="../assets/icons.svg#icon-1"></use></svg><span>libp2p</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>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/62ce7b29e1f7b8ebdcd00c25a099fecfec335197/packages/interface/src/transport/index.ts#L95">packages/interface/src/transport/index.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NO_FATAL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>NO_<wbr/>FATAL</span><a href="#NO_FATAL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">NO_<wbr/>FATAL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><div class="tsd-comment tsd-typography"><p>should be used for not failing when not listening</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/libp2p/js-libp2p/blob/62ce7b29e1f7b8ebdcd00c25a099fecfec335197/packages/interface/src/transport/index.ts#L100">packages/interface/src/transport/index.ts:100</a></li></ul></aside></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="../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="#FATAL_ALL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FATAL_<wbr/>ALL</span></a><a href="#NO_FATAL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>NO_<wbr/>FATAL</span></a></div></details></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="../assets/icons.svg#icon-1"></use></svg><span>libp2p</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>