From 70be111e5d9e17ba497922784390b543b2e3363f Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Thu, 27 Aug 2020 16:56:33 +0200 Subject: [PATCH] chore: update documentation --- index.html | 416 ++++++++++++++++++++++++++--------------------------- 1 file changed, 208 insertions(+), 208 deletions(-) diff --git a/index.html b/index.html index 4b618292..4dc17449 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.29.0-rc.1 | Documentation + libp2p 0.29.0 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.29.0-rc.1
+
0.29.0
- + src/index.js @@ -2020,7 +2020,7 @@
- + src/index.js @@ -2110,7 +2110,7 @@ instance if one is not provided in options.

- + src/index.js @@ -2198,7 +2198,7 @@ if there is a handler. If not, errors will be logged.

- + src/index.js @@ -2264,7 +2264,7 @@ if there is a handler. If not, errors will be logged.

- + src/index.js @@ -2330,7 +2330,7 @@ if there is a handler. If not, errors will be logged.

- + src/index.js @@ -2397,7 +2397,7 @@ Imports the private key as 'self', if needed.

- + src/index.js @@ -2464,7 +2464,7 @@ Imports the private key as 'self', if needed.

- + src/index.js @@ -2577,7 +2577,7 @@ peer will be added to the nodes peerStore

- + src/index.js @@ -2699,7 +2699,7 @@ and the Connection will be returned

- + src/index.js @@ -2767,7 +2767,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

- + src/index.js @@ -2847,7 +2847,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

- + src/index.js @@ -2927,7 +2927,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

- + src/index.js @@ -3006,7 +3006,7 @@ Duplicated addresses and noAnnounce addresses are filtered out.

- + src/index.js @@ -3086,7 +3086,7 @@ will no longer be supported on streams.

- + src/peer-routing.js @@ -3195,7 +3195,7 @@ will no longer be supported on streams.

- + src/content-routing.js @@ -3314,7 +3314,7 @@ Once a content router succeeds, iteration will stop.

- + src/content-routing.js @@ -3391,7 +3391,7 @@ a provider of the given key.

- + src/content-routing.js @@ -3508,7 +3508,7 @@ a provider of the given key.

- + src/content-routing.js @@ -3618,7 +3618,7 @@ Times out after 1 minute by default.

- + src/content-routing.js @@ -3735,7 +3735,7 @@ Times out after 1 minute by default.

- + src/get-peer.js @@ -3819,7 +3819,7 @@ If a multiaddr is received, the addressBook is updated.

- + src/address-manager/index.js @@ -3943,7 +3943,7 @@ address adverstising to other peers in the network.

- + src/address-manager/index.js @@ -4009,7 +4009,7 @@ address adverstising to other peers in the network.

- + src/address-manager/index.js @@ -4075,7 +4075,7 @@ address adverstising to other peers in the network.

- + src/address-manager/index.js @@ -4149,7 +4149,7 @@ address adverstising to other peers in the network.

- + src/connection-manager/index.js @@ -4229,7 +4229,7 @@ address adverstising to other peers in the network.

- + src/connection-manager/index.js @@ -4292,7 +4292,7 @@ address adverstising to other peers in the network.

- + src/connection-manager/index.js @@ -4355,7 +4355,7 @@ address adverstising to other peers in the network.

- + src/connection-manager/index.js @@ -4413,7 +4413,7 @@ address adverstising to other peers in the network.

- + src/connection-manager/index.js @@ -4472,7 +4472,7 @@ only event loop and connection limits will be monitored.

- + src/connection-manager/index.js @@ -4530,7 +4530,7 @@ only event loop and connection limits will be monitored.

- + src/connection-manager/index.js @@ -4588,7 +4588,7 @@ only event loop and connection limits will be monitored.

- + src/connection-manager/index.js @@ -4669,7 +4669,7 @@ will be disconnected first.

- + src/connection-manager/index.js @@ -4740,7 +4740,7 @@ will be disconnected first.

- + src/connection-manager/index.js @@ -4811,7 +4811,7 @@ will be disconnected first.

- + src/connection-manager/index.js @@ -4890,7 +4890,7 @@ will be disconnected first.

- + src/connection-manager/index.js @@ -4977,7 +4977,7 @@ will be disconnected first.

- + src/connection-manager/latency-monitor.js @@ -5031,7 +5031,7 @@ will be disconnected first.

- + src/connection-manager/latency-monitor.js @@ -5129,7 +5129,7 @@ will be disconnected first.

- + src/connection-manager/latency-monitor.js @@ -5304,7 +5304,7 @@ monitor.on('data', (summary) => - + src/connection-manager/latency-monitor.js @@ -5379,7 +5379,7 @@ it will not count for this time period

- + src/connection-manager/visibility-change-emitter.js @@ -5433,7 +5433,7 @@ it will not count for this time period

- + src/connection-manager/visibility-change-emitter.js @@ -5507,7 +5507,7 @@ it will not count for this time period

- + src/connection-manager/visibility-change-emitter.js @@ -5570,7 +5570,7 @@ it will not count for this time period

- + src/circuit/index.js @@ -5669,7 +5669,7 @@ it will not count for this time period

- + src/circuit/index.js @@ -5779,7 +5779,7 @@ it will not count for this time period

- + src/circuit/index.js @@ -5862,7 +5862,7 @@ it will not count for this time period

- + src/circuit/index.js @@ -5937,7 +5937,7 @@ it will not count for this time period

- + src/circuit/index.js @@ -5991,7 +5991,7 @@ it will not count for this time period

- + src/identify/index.js @@ -6059,7 +6059,7 @@ it will not count for this time period

- + src/circuit/listener.js @@ -6129,7 +6129,7 @@ it will not count for this time period

- + src/circuit/listener.js @@ -6208,7 +6208,7 @@ it will not count for this time period

- + src/circuit/listener.js @@ -6274,7 +6274,7 @@ it will not count for this time period

- + src/circuit/listener.js @@ -6359,7 +6359,7 @@ be dialed over TCP rather than any other transport

- + src/circuit/circuit/hop.js @@ -6476,7 +6476,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6551,7 +6551,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6627,7 +6627,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6730,7 +6730,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6792,7 +6792,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6860,7 +6860,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6922,7 +6922,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6984,7 +6984,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7172,7 +7172,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7226,7 +7226,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7338,7 +7338,7 @@ will be used.

- + src/dialer/index.js @@ -7421,7 +7421,7 @@ will be used.

- + src/dialer/index.js @@ -7524,7 +7524,7 @@ will be used.

- + src/dialer/dial-request.js @@ -7635,7 +7635,7 @@ all other dials in the request will be cancelled.

- + src/dialer/dial-request.js @@ -7734,7 +7734,7 @@ all other dials in the request will be cancelled.

- + src/keychain/index.js @@ -7812,7 +7812,7 @@ all other dials in the request will be cancelled.

- + src/keychain/index.js @@ -7890,7 +7890,7 @@ all other dials in the request will be cancelled.

- + src/keychain/index.js @@ -7956,7 +7956,7 @@ all other dials in the request will be cancelled.

- + src/keychain/index.js @@ -8031,7 +8031,7 @@ The default options for a keychain.

- + src/keychain/index.js @@ -8101,7 +8101,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8199,7 +8199,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8265,7 +8265,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8345,7 +8345,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8425,7 +8425,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8505,7 +8505,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8594,7 +8594,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8683,7 +8683,7 @@ arbitrary message content.

- + src/keychain/index.js @@ -8789,7 +8789,7 @@ arbitrary message content.

- + src/keychain/cms.js @@ -8859,7 +8859,7 @@ arbitrary message content.

- + src/keychain/cms.js @@ -8949,7 +8949,7 @@ arbitrary message content.

- + src/keychain/cms.js @@ -9039,7 +9039,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9126,7 +9126,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9205,7 +9205,7 @@ resolve to either true or false.

- + src/metrics/index.js @@ -9327,7 +9327,7 @@ resolve to either true or false.

- + src/metrics/index.js @@ -9382,7 +9382,7 @@ will be ignored.

- + src/metrics/index.js @@ -9437,7 +9437,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9499,7 +9499,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9561,7 +9561,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9637,7 +9637,7 @@ is a live peer, or in the disconnected peer LRU cache.

- + src/metrics/index.js @@ -9699,7 +9699,7 @@ is a live peer, or in the disconnected peer LRU cache.

- + src/metrics/index.js @@ -9774,7 +9774,7 @@ is a live peer, or in the disconnected peer LRU cache.

- + src/metrics/index.js @@ -9843,7 +9843,7 @@ be stopped and moved to an LRU for temporary retention.

- + src/metrics/index.js @@ -9921,7 +9921,7 @@ placeholder stats will be merged with the existing stats.

- + src/metrics/index.js @@ -10051,7 +10051,7 @@ with the placeholder string returned from here, and the known PeerId - + src/metrics/index.js @@ -10135,7 +10135,7 @@ and returned.

- + src/metrics/old-peers.js @@ -10210,7 +10210,7 @@ and returned.

- + src/metrics/stats.js @@ -10290,7 +10290,7 @@ and returned.

- + src/metrics/stats.js @@ -10358,7 +10358,7 @@ should only need to be called if Stats.stop was previously called,
- + src/metrics/stats.js @@ -10425,7 +10425,7 @@ timer.

- + src/metrics/stats.js @@ -10491,7 +10491,7 @@ timer.

- + src/metrics/stats.js @@ -10557,7 +10557,7 @@ timer.

- + src/metrics/stats.js @@ -10623,7 +10623,7 @@ timer.

- + src/metrics/stats.js @@ -10719,7 +10719,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -10830,7 +10830,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -10923,7 +10923,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -10977,7 +10977,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11060,7 +11060,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11122,7 +11122,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11184,7 +11184,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11259,7 +11259,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11313,7 +11313,7 @@ current Timestamp, then resets the update timer.

- + src/transport-manager.js @@ -11381,7 +11381,7 @@ If a transport has any running listeners, they will be closed.

- + src/transport-manager.js @@ -11436,7 +11436,7 @@ If any listeners are running, they will be closed.

- + src/transport-manager.js @@ -11497,7 +11497,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -11658,7 +11658,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -11737,7 +11737,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -11824,7 +11824,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -11988,7 +11988,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -12067,7 +12067,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/upgrader.js @@ -12154,7 +12154,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12250,7 +12250,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12308,7 +12308,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12366,7 +12366,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12424,7 +12424,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12482,7 +12482,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12540,7 +12540,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12598,7 +12598,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12664,7 +12664,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12743,7 +12743,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/index.js @@ -12830,7 +12830,7 @@ NO_FATAL should be used for not failing when not listening.

- + src/peer-store/address-book.js @@ -12903,7 +12903,7 @@ of a peer.

- + src/peer-store/address-book.js @@ -12966,7 +12966,7 @@ of a peer.

- + src/peer-store/address-book.js @@ -13047,7 +13047,7 @@ into the AddressBook.

- + src/peer-store/address-book.js @@ -13127,7 +13127,7 @@ undefined if no Envelope is found.

- + src/peer-store/address-book.js @@ -13207,7 +13207,7 @@ Returns undefined if no record exists.

- + src/peer-store/address-book.js @@ -13297,7 +13297,7 @@ If you are not sure, it's recommended to use add instead.

- + src/peer-store/address-book.js @@ -13385,7 +13385,7 @@ If the peer is not known, it is set with the given addresses.

- + src/peer-store/address-book.js @@ -13464,7 +13464,7 @@ If the peer is not known, it is set with the given addresses.

- + src/peer-store/address-book.js @@ -13553,7 +13553,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/address-book.js @@ -13609,7 +13609,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/proto-book.js @@ -13664,7 +13664,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/book.js @@ -13787,7 +13787,7 @@ Returns undefined if there are no known multiaddrs for the given pe
- + src/peer-store/book.js @@ -13845,7 +13845,7 @@ Returns undefined if there are no known multiaddrs for the given pe
- + src/peer-store/book.js @@ -13924,7 +13924,7 @@ Returns undefined if there are no known multiaddrs for the given pe
- + src/peer-store/book.js @@ -14004,7 +14004,7 @@ Returns undefined if there is no available data for the given peer.
- + src/peer-store/book.js @@ -14091,7 +14091,7 @@ Returns undefined if there is no available data for the given peer. - + src/peer-store/key-book.js @@ -14163,7 +14163,7 @@ Returns undefined if there is no available data for the given peer.
- + src/peer-store/key-book.js @@ -14226,7 +14226,7 @@ Returns undefined if there is no available data for the given peer.
- + src/peer-store/key-book.js @@ -14313,7 +14313,7 @@ Returns undefined if there is no available data for the given peer.
- + src/peer-store/key-book.js @@ -14400,7 +14400,7 @@ Returns undefined if there is no available data for the given peer. - + src/peer-store/metadata-book.js @@ -14473,7 +14473,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -14536,7 +14536,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -14633,7 +14633,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -14755,7 +14755,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -14834,7 +14834,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -14921,7 +14921,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -15000,7 +15000,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -15095,7 +15095,7 @@ protocols of a peer.

- + src/peer-store/metadata-book.js @@ -15150,7 +15150,7 @@ protocols of a peer.

- + src/peer-store/proto-book.js @@ -15223,7 +15223,7 @@ protocols of a peer.

- + src/peer-store/proto-book.js @@ -15286,7 +15286,7 @@ protocols of a peer.

- + src/peer-store/proto-book.js @@ -15374,7 +15374,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/proto-book.js @@ -15470,7 +15470,7 @@ If the peer was not known before, it will be added.

- + src/pubsub-adapter.js @@ -15553,7 +15553,7 @@ If the peer was not known before, it will be added.

- + src/pubsub-adapter.js @@ -15636,7 +15636,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/persistent/index.js @@ -15758,7 +15758,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/persistent/index.js @@ -15816,7 +15816,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/persistent/index.js @@ -15874,7 +15874,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/persistent/index.js @@ -15937,7 +15937,7 @@ If the peer was not known before, it will be added.

- + src/peer-store/persistent/index.js @@ -16011,7 +16011,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16116,7 +16116,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16179,7 +16179,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16258,7 +16258,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16338,7 +16338,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16418,7 +16418,7 @@ If the peer was not known before, it will be added.

- + src/registrar.js @@ -16513,7 +16513,7 @@ If the peer was not known before, it will be added.

- + src/ping/index.js @@ -16596,7 +16596,7 @@ If the peer was not known before, it will be added.

- + src/ping/index.js @@ -16663,7 +16663,7 @@ If the peer was not known before, it will be added.

- + src/ping/index.js @@ -16730,7 +16730,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -16829,7 +16829,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -16882,7 +16882,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -16935,7 +16935,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -16988,7 +16988,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -17041,7 +17041,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -17116,7 +17116,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -17183,7 +17183,7 @@ If the peer was not known before, it will be added.

- + src/identify/index.js @@ -17260,7 +17260,7 @@ an error will be thrown.

- + src/identify/index.js @@ -17375,7 +17375,7 @@ an error will be thrown.

- + src/identify/index.js @@ -17437,7 +17437,7 @@ an error will be thrown.

- + src/identify/index.js @@ -17512,7 +17512,7 @@ an error will be thrown.

- + src/record/envelope/index.js @@ -17632,7 +17632,7 @@ by a libp2p peer.

- + src/record/envelope/index.js @@ -17711,7 +17711,7 @@ by a libp2p peer.

- + src/record/envelope/index.js @@ -17799,7 +17799,7 @@ and signs it with the given peerId's private key.

- + src/record/envelope/index.js @@ -17895,7 +17895,7 @@ Data is unmarshalled and the signature validated for the given domain.

- + src/record/envelope/index.js @@ -17961,7 +17961,7 @@ Data is unmarshalled and the signature validated for the given domain.

- + src/record/envelope/index.js @@ -18040,7 +18040,7 @@ Data is unmarshalled and the signature validated for the given domain.

- + src/record/envelope/index.js @@ -18127,7 +18127,7 @@ Data is unmarshalled and the signature validated for the given domain.

- + src/record/envelope/index.js @@ -18218,7 +18218,7 @@ Data is unmarshalled and the signature validated for the given domain.

- + src/record/peer-record/index.js @@ -18341,7 +18341,7 @@ It contains the peer's reachable listen addresses.

- + src/record/peer-record/index.js @@ -18429,7 +18429,7 @@ It contains the peer's reachable listen addresses.

- + src/record/peer-record/index.js @@ -18495,7 +18495,7 @@ It contains the peer's reachable listen addresses.

- + src/record/peer-record/index.js