diff --git a/index.html b/index.html index 7733ad82..59fc0d8d 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.29.2 | Documentation + libp2p 0.29.3 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.29.2
+
0.29.3
+
  • + _resolve + + + +
    • + + +
  • + _resolveRecord + + + +
    • + +
  • @@ -1957,7 +1977,7 @@ - + src/index.js @@ -2026,7 +2046,7 @@
    - + src/index.js @@ -2116,7 +2136,7 @@ instance if one is not provided in options.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/circuit/circuit/hop.js @@ -6435,7 +6455,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6510,7 +6530,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6586,7 +6606,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6689,7 +6709,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6751,7 +6771,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6819,7 +6839,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6881,7 +6901,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6943,7 +6963,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7034,6 +7054,17 @@ peer. A new, virtual, connection will be created between the two via the relay.< + + options.resolvers object + + (default {}) + + multiaddr resolvers to use when dialing + + + + + @@ -7074,7 +7105,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7128,7 +7159,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7240,7 +7271,7 @@ will be used.

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

    - + src/dialer/index.js @@ -7411,6 +7442,156 @@ will be used.

    + + + + + +
    + + +
    + +

    + _resolve +

    + + + + src/dialer/index.js + + +
    + + +

    Resolve multiaddr recursively.

    + +
    _resolve(ma: Multiaddr): Promise<Array<Multiaddr>>
    + + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + ma (Multiaddr) + +
    + +
    + +
    + + + + + + +
    Returns
    + Promise<Array<Multiaddr>>: + + + + + + + + + + + + + + + + + + + +
    + + + + +
    + + +
    + +

    + _resolveRecord +

    + + + + src/dialer/index.js + + +
    + + +

    Resolve a given multiaddr. If this fails, an empty array will be returned

    + +
    _resolveRecord(ma: Multiaddr): Promise<Array<Multiaddr>>
    + + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + ma (Multiaddr) + +
    + +
    + +
    + + + + + + +
    Returns
    + Promise<Array<Multiaddr>>: + + + + + + + + + + + + + + + + + + +
    @@ -7426,7 +7607,7 @@ will be used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/keychain/cms.js @@ -8941,7 +9122,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9028,7 +9209,7 @@ exists, an Error is returned with the property 'missingKeys'. It is array of ke - + src/keychain/util.js @@ -9107,7 +9288,7 @@ resolve to either true or false.

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

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

    - + src/metrics/index.js @@ -9339,7 +9520,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9401,7 +9582,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9463,7 +9644,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -9539,7 +9720,7 @@ is a live peer, or in the disconnected peer LRU cache.

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

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

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

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

    - + src/metrics/index.js @@ -9945,7 +10126,7 @@ with the placeholder string returned from here, and the known PeerId - + src/metrics/index.js @@ -10029,7 +10210,7 @@ and returned.

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

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

    - + src/metrics/stats.js @@ -10252,7 +10433,7 @@ should only need to be called if Stats.stop was previously called,
    - + src/metrics/stats.js @@ -10319,7 +10500,7 @@ timer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/peer-store/address-book.js @@ -13455,7 +13636,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/address-book.js @@ -13511,7 +13692,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/proto-book.js @@ -13566,7 +13747,7 @@ Returns undefined if there are no known multiaddrs for the given pe - + src/peer-store/book.js @@ -13689,7 +13870,7 @@ Returns undefined if there are no known multiaddrs for the given pe
    - + src/peer-store/book.js @@ -13747,7 +13928,7 @@ Returns undefined if there are no known multiaddrs for the given pe
    - + src/peer-store/book.js @@ -13826,7 +14007,7 @@ Returns undefined if there are no known multiaddrs for the given pe
    - + src/peer-store/book.js @@ -13906,7 +14087,7 @@ Returns undefined if there is no available data for the given peer.
    - + src/peer-store/book.js @@ -13993,7 +14174,7 @@ Returns undefined if there is no available data for the given peer. - + src/peer-store/key-book.js @@ -14065,7 +14246,7 @@ Returns undefined if there is no available data for the given peer.
    - + src/peer-store/key-book.js @@ -14128,7 +14309,7 @@ Returns undefined if there is no available data for the given peer.
    - + src/peer-store/key-book.js @@ -14215,7 +14396,7 @@ Returns undefined if there is no available data for the given peer.
    - + src/peer-store/key-book.js @@ -14302,7 +14483,7 @@ Returns undefined if there is no available data for the given peer. - + src/peer-store/metadata-book.js @@ -14375,7 +14556,7 @@ protocols of a peer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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