From b89a8adaa222a6a35f9bc21e7df5019f2d12286c Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Fri, 16 Apr 2021 15:55:14 +0200 Subject: [PATCH] chore: update documentation --- classes/libp2p.html | 43 ++++++++++++++---------------- index.html | 8 +++--- interfaces/constructoroptions.html | 8 +++--- interfaces/createoptions.html | 8 +++--- interfaces/dhtoptions.html | 8 +++--- interfaces/handlerprops.html | 8 +++--- interfaces/keychainoptions.html | 8 +++--- interfaces/libp2pconfig.html | 8 +++--- interfaces/libp2pmodules.html | 8 +++--- interfaces/libp2poptions.html | 8 +++--- interfaces/metricsoptions.html | 8 +++--- interfaces/peerstoreoptions.html | 8 +++--- interfaces/pubsublocaloptions.html | 8 +++--- interfaces/randomwalkoptions.html | 8 +++--- interfaces/relayoptions.html | 8 +++--- modules.html | 8 +++--- 16 files changed, 80 insertions(+), 83 deletions(-) diff --git a/classes/libp2p.html b/classes/libp2p.html index 45cc74d0..84c12402 100644 --- a/classes/libp2p.html +++ b/classes/libp2p.html @@ -3,8 +3,8 @@ - Libp2p | libp2p - v0.31.0-rc.0 - + Libp2p | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • Libp2p @@ -631,7 +631,7 @@
    • @@ -660,7 +660,7 @@
    • @@ -695,7 +695,7 @@
    • @@ -727,7 +727,7 @@
    • @@ -749,7 +749,7 @@
    • @@ -791,7 +791,7 @@

    • Returns Promise<void>

      @@ -808,7 +808,7 @@
    • @@ -908,20 +908,20 @@

      dialProtocol

        -
      • dialProtocol(peer: string | Multiaddr | PeerId, protocols: string | string[], options: undefined | { signal: undefined | AbortSignal }): Promise<Connection | { protocol: string; stream: MuxedStream }>
        • +
      • dialProtocol(peer: string | Multiaddr | PeerId, protocols: string | string[], options: undefined | { signal: undefined | AbortSignal }): Promise<{ protocol: string; stream: MuxedStream }>
      • -

        Dials to the provided peer and handshakes with the given protocol. +

        Dials to the provided peer and tries to handshake with the given protocols in order. If successful, the known metadata of the peer will be added to the nodes peerStore, - and the Connection will be returned

        + and the MuxedStream will be returned together with the successful negotiated protocol.

        async
        @@ -943,10 +943,7 @@
        options: undefined | { signal: undefined | AbortSignal }
      -

      Returns Promise<Connection | { protocol: string; stream: MuxedStream }>

      -
      -

      }

      -
      +

      Returns Promise<{ protocol: string; stream: MuxedStream }>

    @@ -1029,7 +1026,7 @@
  • @@ -1080,7 +1077,7 @@
  • @@ -1338,7 +1335,7 @@
  • @@ -1624,7 +1621,7 @@
  • diff --git a/index.html b/index.html index 6c3dd57d..3652b262 100644 --- a/index.html +++ b/index.html @@ -3,8 +3,8 @@ - libp2p - v0.31.0-rc.0 - + libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -50,7 +50,7 @@
    -

    libp2p - v0.31.0-rc.0

    +

    libp2p - v0.31.0-rc.1

    diff --git a/interfaces/constructoroptions.html b/interfaces/constructoroptions.html index fc26fed4..50668c54 100644 --- a/interfaces/constructoroptions.html +++ b/interfaces/constructoroptions.html @@ -3,8 +3,8 @@ - constructorOptions | libp2p - v0.31.0-rc.0 - + constructorOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • constructorOptions diff --git a/interfaces/createoptions.html b/interfaces/createoptions.html index 44efb77b..50800625 100644 --- a/interfaces/createoptions.html +++ b/interfaces/createoptions.html @@ -3,8 +3,8 @@ - CreateOptions | libp2p - v0.31.0-rc.0 - + CreateOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • CreateOptions diff --git a/interfaces/dhtoptions.html b/interfaces/dhtoptions.html index 84d78ed9..4eab6ac8 100644 --- a/interfaces/dhtoptions.html +++ b/interfaces/dhtoptions.html @@ -3,8 +3,8 @@ - DhtOptions | libp2p - v0.31.0-rc.0 - + DhtOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • DhtOptions diff --git a/interfaces/handlerprops.html b/interfaces/handlerprops.html index 9e63713d..2ca2f43a 100644 --- a/interfaces/handlerprops.html +++ b/interfaces/handlerprops.html @@ -3,8 +3,8 @@ - HandlerProps | libp2p - v0.31.0-rc.0 - + HandlerProps | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • HandlerProps diff --git a/interfaces/keychainoptions.html b/interfaces/keychainoptions.html index 94269265..38e5d75d 100644 --- a/interfaces/keychainoptions.html +++ b/interfaces/keychainoptions.html @@ -3,8 +3,8 @@ - KeychainOptions | libp2p - v0.31.0-rc.0 - + KeychainOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • KeychainOptions diff --git a/interfaces/libp2pconfig.html b/interfaces/libp2pconfig.html index 5949afca..adfb994b 100644 --- a/interfaces/libp2pconfig.html +++ b/interfaces/libp2pconfig.html @@ -3,8 +3,8 @@ - Libp2pConfig | libp2p - v0.31.0-rc.0 - + Libp2pConfig | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • Libp2pConfig diff --git a/interfaces/libp2pmodules.html b/interfaces/libp2pmodules.html index fd15f57e..c85e22db 100644 --- a/interfaces/libp2pmodules.html +++ b/interfaces/libp2pmodules.html @@ -3,8 +3,8 @@ - Libp2pModules | libp2p - v0.31.0-rc.0 - + Libp2pModules | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • Libp2pModules diff --git a/interfaces/libp2poptions.html b/interfaces/libp2poptions.html index 18c975b2..737bff7c 100644 --- a/interfaces/libp2poptions.html +++ b/interfaces/libp2poptions.html @@ -3,8 +3,8 @@ - Libp2pOptions | libp2p - v0.31.0-rc.0 - + Libp2pOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • Libp2pOptions diff --git a/interfaces/metricsoptions.html b/interfaces/metricsoptions.html index 61232fe9..310f024a 100644 --- a/interfaces/metricsoptions.html +++ b/interfaces/metricsoptions.html @@ -3,8 +3,8 @@ - MetricsOptions | libp2p - v0.31.0-rc.0 - + MetricsOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • MetricsOptions diff --git a/interfaces/peerstoreoptions.html b/interfaces/peerstoreoptions.html index 3ffd0135..c5ac5c34 100644 --- a/interfaces/peerstoreoptions.html +++ b/interfaces/peerstoreoptions.html @@ -3,8 +3,8 @@ - PeerStoreOptions | libp2p - v0.31.0-rc.0 - + PeerStoreOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • PeerStoreOptions diff --git a/interfaces/pubsublocaloptions.html b/interfaces/pubsublocaloptions.html index 22e5c1eb..926de063 100644 --- a/interfaces/pubsublocaloptions.html +++ b/interfaces/pubsublocaloptions.html @@ -3,8 +3,8 @@ - PubsubLocalOptions | libp2p - v0.31.0-rc.0 - + PubsubLocalOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • PubsubLocalOptions diff --git a/interfaces/randomwalkoptions.html b/interfaces/randomwalkoptions.html index 540e0dd6..a7643440 100644 --- a/interfaces/randomwalkoptions.html +++ b/interfaces/randomwalkoptions.html @@ -3,8 +3,8 @@ - RandomWalkOptions | libp2p - v0.31.0-rc.0 - + RandomWalkOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • RandomWalkOptions diff --git a/interfaces/relayoptions.html b/interfaces/relayoptions.html index b1d649c0..4e4644a9 100644 --- a/interfaces/relayoptions.html +++ b/interfaces/relayoptions.html @@ -3,8 +3,8 @@ - RelayOptions | libp2p - v0.31.0-rc.0 - + RelayOptions | libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    • RelayOptions diff --git a/modules.html b/modules.html index f5fe63a6..65ce7497 100644 --- a/modules.html +++ b/modules.html @@ -3,8 +3,8 @@ - libp2p - v0.31.0-rc.0 - + libp2p - v0.31.0-rc.1 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.0-rc.0 + libp2p - v0.31.0-rc.1
    @@ -50,7 +50,7 @@
    -

    libp2p - v0.31.0-rc.0

    +

    libp2p - v0.31.0-rc.1