diff --git a/index.html b/index.html index e1fd9c29..78d733b6 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.27.0-pre.1 | Documentation + libp2p 0.27.0-pre.2 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.27.0-pre.1
+
0.27.0-pre.2
+
  • + #connections +
    • +
  • @@ -1254,7 +1260,7 @@ - + src/index.js @@ -1323,7 +1329,7 @@
    - + src/index.js @@ -1409,7 +1415,7 @@ if there is a handler. If not, errors will be logged.

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

    - + src/index.js @@ -1518,6 +1524,71 @@ if there is a handler. If not, errors will be logged.

    + + +
    +
    + +
    +
    +
    + ▸ + connections +
    +
    + @@ -1537,7 +1608,7 @@ if there is a handler. If not, errors will be logged.

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

    - + src/index.js @@ -1768,7 +1839,7 @@ and the Connection will be sent in the callback

    - + src/index.js @@ -1777,7 +1848,7 @@ and the Connection will be sent in the callback

    Disconnects all connections to the given peer

    -
    hangUp(peer: PeerId): Promise<void>
    +
    hangUp(peer: (PeerInfo | PeerId | multiaddr | string)): Promise<void>
    @@ -1794,8 +1865,8 @@ and the Connection will be sent in the callback

    - peer (PeerId) - The PeerId to close connections to + peer ((PeerInfo | PeerId | multiaddr | string)) + the peer to close connections to
    @@ -1846,7 +1917,7 @@ and the Connection will be sent in the callback

    - + src/index.js @@ -1924,7 +1995,7 @@ and the Connection will be sent in the callback

    - + src/index.js @@ -2001,7 +2072,7 @@ and the Connection will be sent in the callback

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

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

    - + src/index.js @@ -2211,7 +2282,7 @@ instance if one is not provided in options.

    - + src/identify/index.js @@ -2277,7 +2348,7 @@ instance if one is not provided in options.

    - + src/peer-routing.js @@ -2384,7 +2455,7 @@ instance if one is not provided in options.

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

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

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

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

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

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

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

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

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

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

    - + src/get-peer-info.js @@ -3367,7 +3438,7 @@ the peer will be updated in the PeerStore.

    - + src/get-peer-info.js @@ -3449,7 +3520,7 @@ the libp2p PeerRouter will be used to attempt to find the peer.

    - + src/connection-manager/index.js @@ -3618,7 +3689,7 @@ the libp2p PeerRouter will be used to attempt to find the peer.

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

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

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

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

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

    - + src/circuit/index.js @@ -4025,7 +4096,7 @@ will be disconnected first.

    - + src/circuit/index.js @@ -4133,7 +4204,7 @@ will be disconnected first.

    - + src/circuit/index.js @@ -4214,7 +4285,7 @@ will be disconnected first.

    - + src/circuit/index.js @@ -4287,7 +4358,7 @@ will be disconnected first.

    - + src/circuit/listener.js @@ -4355,7 +4426,7 @@ will be disconnected first.

    - + src/circuit/listener.js @@ -4432,7 +4503,7 @@ will be disconnected first.

    - + src/circuit/listener.js @@ -4496,7 +4567,7 @@ will be disconnected first.

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

    - + src/circuit/circuit/hop.js @@ -4694,7 +4765,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -4767,7 +4838,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -4841,7 +4912,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -4942,7 +5013,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -5002,7 +5073,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -5068,7 +5139,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -5128,7 +5199,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -5188,7 +5259,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -5374,7 +5445,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -5426,7 +5497,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -5536,7 +5607,7 @@ will be used.

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

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

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

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

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

    - + src/metrics/index.js @@ -6109,7 +6180,7 @@ all other dials in the request will be cancelled.

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

    - + src/metrics/index.js @@ -6215,7 +6286,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -6275,7 +6346,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -6335,7 +6406,7 @@ Once stop is called, start must be called to resume st - + src/metrics/index.js @@ -6409,7 +6480,7 @@ is a live peer, or in the disconnected peer LRU cache.

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

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

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

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

    - + src/metrics/index.js @@ -6813,7 +6884,7 @@ with the placeholder string returned from here, and the known PeerId - + src/metrics/index.js @@ -6895,7 +6966,7 @@ and returned.

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

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

    - + src/metrics/stats.js @@ -7112,7 +7183,7 @@ should only need to be called if Stats.stop was previously called,
    - + src/metrics/stats.js @@ -7177,7 +7248,7 @@ timer.

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

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

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

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

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

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

    Adds a Transport to the manager

    -
    add(key: String, Transport: Transport): void
    +
    add(key: String, Transport: Transport, transportOptions: any): void
    @@ -7601,6 +7672,16 @@ current Timestamp, then resets the update timer.

    +
    +
    + transportOptions (any + = {}) + Additional options to pass to the transport + +
    + +
    +
    @@ -7642,7 +7723,7 @@ current Timestamp, then resets the update timer.

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

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

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

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

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

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

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

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

    - + src/upgrader.js @@ -8311,7 +8392,7 @@ If any listeners are running, they will be closed.

    - + src/upgrader.js @@ -8388,7 +8469,7 @@ If any listeners are running, they will be closed.

    - + src/upgrader.js @@ -8473,7 +8554,7 @@ If any listeners are running, they will be closed.

    - + src/upgrader.js @@ -8635,7 +8716,7 @@ If any listeners are running, they will be closed.

    - + src/upgrader.js @@ -8712,7 +8793,7 @@ If any listeners are running, they will be closed.

    - + src/upgrader.js @@ -8797,7 +8878,7 @@ If any listeners are running, they will be closed.

    - + src/peer-store/index.js @@ -8854,7 +8935,7 @@ If any listeners are running, they will be closed.

    - + src/peer-store/index.js @@ -8915,7 +8996,7 @@ If any listeners are running, they will be closed.

    - + src/peer-store/index.js @@ -9030,7 +9111,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9107,7 +9188,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9184,7 +9265,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9262,7 +9343,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9340,7 +9421,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9418,7 +9499,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9495,7 +9576,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/peer-store/index.js @@ -9580,7 +9661,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/registrar.js @@ -9675,7 +9756,7 @@ known, but may not have been added to the PeerStore yet.

    - + src/registrar.js @@ -9737,7 +9818,7 @@ TODO: this should be handled by connectionManager

    - + src/registrar.js @@ -9798,7 +9879,7 @@ TODO: this should be handled by connectionManager

    - + src/registrar.js @@ -9854,7 +9935,7 @@ TODO: this should be handled by connectionManager

    - + src/registrar.js @@ -9940,7 +10021,7 @@ TODO: this should live in the ConnectionManager

    - + src/registrar.js @@ -10034,7 +10115,7 @@ TODO: this should live in the ConnectionManager

    - + src/registrar.js @@ -10111,7 +10192,7 @@ TODO: this should live in the ConnectionManager

    - + src/registrar.js @@ -10189,7 +10270,7 @@ TODO: this should live in the ConnectionManager

    - + src/registrar.js @@ -10275,7 +10356,7 @@ TODO: this should live in the ConnectionManager

    - + src/ping/index.js @@ -10356,7 +10437,7 @@ TODO: this should live in the ConnectionManager

    - + src/ping/index.js @@ -10421,7 +10502,7 @@ TODO: this should live in the ConnectionManager

    - + src/ping/index.js @@ -10486,7 +10567,7 @@ TODO: this should live in the ConnectionManager

    - + src/identify/index.js @@ -10592,7 +10673,7 @@ TODO: this should live in the ConnectionManager

    - + src/identify/index.js @@ -10643,7 +10724,7 @@ TODO: this should live in the ConnectionManager

    - + src/identify/index.js @@ -10694,7 +10775,7 @@ TODO: this should live in the ConnectionManager

    - + src/identify/index.js @@ -10767,7 +10848,7 @@ TODO: this should live in the ConnectionManager

    - + src/identify/index.js @@ -10832,7 +10913,7 @@ TODO: this should live in the ConnectionManager

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

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

    - + src/identify/index.js @@ -11094,7 +11175,7 @@ with the provided multiaddrs

    - + src/identify/index.js @@ -11168,7 +11249,7 @@ with the provided protocols

    - + src/identify/index.js