diff --git a/index.html b/index.html index e119ab01..0cfa6719 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.28.1 | Documentation + libp2p 0.28.2 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.28.1
+
0.28.2
+
  • + Book + ▸ + + + + +
    • + +
  • @@ -1506,52 +1552,6 @@
    • -
  • - Book - ▸ - - - - -
    • - -
  • @@ -1867,7 +1867,7 @@ - + src/index.js @@ -1936,7 +1936,7 @@
    - + src/index.js @@ -2026,7 +2026,7 @@ instance if one is not provided in options.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/pubsub.js @@ -3811,7 +3811,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3894,7 +3894,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -3956,7 +3956,7 @@ Times out after 1 minute by default.

    - + src/pubsub.js @@ -4031,7 +4031,7 @@ Times out after 1 minute by default.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/circuit/circuit/hop.js @@ -6772,7 +6772,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6847,7 +6847,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6923,7 +6923,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7026,7 +7026,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7088,7 +7088,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7156,7 +7156,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7218,7 +7218,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7280,7 +7280,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7468,7 +7468,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7522,7 +7522,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7634,7 +7634,7 @@ will be used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/metrics/index.js @@ -9733,7 +9733,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9795,7 +9795,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9857,7 +9857,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9933,7 +9933,7 @@ is a live peer, or in the disconnected peer LRU cache.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/peer-store/address-book.js @@ -13488,7 +13488,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/address-book.js @@ -13544,7 +13544,7 @@ will include the encapsulated PeerId of the peer.

    - + src/peer-store/proto-book.js @@ -13575,1065 +13575,6 @@ will include the encapsulated PeerId of the peer.

    - - - - - - - - - - - - - - -
    - - -
    - -

    - KeyBook -

    - - - - src/peer-store/key-book.js - - -
    - - -

    The KeyBook is responsible for keeping the known public keys of a peer.

    - -
    new KeyBook(peerStore: PeerStore)
    - - -

    - Extends - - Book - -

    - - - - - - - - - - -
    Parameters
    -
    - -
    -
    - peerStore (PeerStore) - -
    - -
    - -
    - - - - - - - - - - - - - - - -
    Instance Members
    -
    - -
    -
    -
    - ▸ - data -
    -
    - -
    - -
    -
    -
    - ▸ - set(peerId, publicKey) -
    -
    - -
    - -
    -
    -
    - ▸ - get(peerId) -
    -
    - -
    - -
    - - - - - - -
    - - - - -
    - - -
    - -

    - MetadataBook -

    - - - - src/peer-store/metadata-book.js - - -
    - - -

    The MetadataBook is responsible for keeping the known supported -protocols of a peer.

    - -
    new MetadataBook(peerStore: PeerStore)
    - - -

    - Extends - - Book - -

    - - - - - - - - - - -
    Parameters
    -
    - -
    -
    - peerStore (PeerStore) - -
    - -
    - -
    - - - - - - - - - - - - - - - -
    Instance Members
    -
    - -
    -
    -
    - ▸ - data -
    -
    - -
    - -
    -
    -
    - ▸ - set(peerId, key, value) -
    -
    - -
    - -
    -
    -
    - ▸ - _setValue(peerId, key, value, $3) -
    -
    - -
    - -
    -
    -
    - ▸ - get(peerId) -
    -
    - -
    - -
    -
    -
    - ▸ - getValue(peerId, key) -
    -
    - -
    - -
    -
    -
    - ▸ - delete(peerId) -
    -
    - -
    - -
    -
    -
    - ▸ - deleteValue(peerId, key) -
    -
    - -
    - -
    - - - - - - -
    - - - - -
    - - -
    - -

    - eventProperty -

    - - - - src/peer-store/metadata-book.js - - -
    - - -

    PeerStore Event emitter, used by the MetadataBook to emit: -"change:metadata" - emitted when the known metadata of a peer change.

    - -
    eventProperty
    - - - - - - - - - - - - - - - - - - - - @@ -14658,7 +13599,7 @@ protocols of a peer.

    - + src/peer-store/book.js @@ -14781,7 +13722,7 @@ protocols of a peer.

    - + src/peer-store/book.js @@ -14839,7 +13780,7 @@ protocols of a peer.

    - + src/peer-store/book.js @@ -14918,7 +13859,7 @@ protocols of a peer.

    - + src/peer-store/book.js @@ -14997,7 +13938,7 @@ protocols of a peer.

    - + src/peer-store/book.js @@ -15063,6 +14004,1065 @@ protocols of a peer.

    + + + + + + +
    + + + + +
    + + +
    + +

    + KeyBook +

    + + + + src/peer-store/key-book.js + + +
    + + +

    The KeyBook is responsible for keeping the known public keys of a peer.

    + +
    new KeyBook(peerStore: PeerStore)
    + + +

    + Extends + + Book + +

    + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + peerStore (PeerStore) + +
    + +
    + +
    + + + + + + + + + + + + + + + +
    Instance Members
    +
    + +
    +
    +
    + ▸ + data +
    +
    + +
    + +
    +
    +
    + ▸ + set(peerId, publicKey) +
    +
    + +
    + +
    +
    +
    + ▸ + get(peerId) +
    +
    + +
    + +
    + + + + + + +
    + + + + +
    + + +
    + +

    + MetadataBook +

    + + + + src/peer-store/metadata-book.js + + +
    + + +

    The MetadataBook is responsible for keeping the known supported +protocols of a peer.

    + +
    new MetadataBook(peerStore: PeerStore)
    + + +

    + Extends + + Book + +

    + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + peerStore (PeerStore) + +
    + +
    + +
    + + + + + + + + + + + + + + + +
    Instance Members
    +
    + +
    +
    +
    + ▸ + data +
    +
    + +
    + +
    +
    +
    + ▸ + set(peerId, key, value) +
    +
    + +
    + +
    +
    +
    + ▸ + _setValue(peerId, key, value, $3) +
    +
    + +
    + +
    +
    +
    + ▸ + get(peerId) +
    +
    + +
    + +
    +
    +
    + ▸ + getValue(peerId, key) +
    +
    + +
    + +
    +
    +
    + ▸ + delete(peerId) +
    +
    + +
    + +
    +
    +
    + ▸ + deleteValue(peerId, key) +
    +
    + +
    + +
    + + + + + + +
    + + + + +
    + + +
    + +

    + eventProperty +

    + + + + src/peer-store/metadata-book.js + + +
    + + +

    PeerStore Event emitter, used by the MetadataBook to emit: +"change:metadata" - emitted when the known metadata of a peer change.

    + +
    eventProperty
    + + + + + + + + + + + + + + + + + + + + + + + @@ -15084,7 +15084,7 @@ protocols of a peer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/identify/index.js