From 950f76b2df93fc915e9c91efecdd269311df03fe Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Thu, 27 May 2021 10:48:18 +0200 Subject: [PATCH] chore: update documentation --- classes/libp2p.html | 80 ++++++++++++++++++++++-------- 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, 118 insertions(+), 82 deletions(-) diff --git a/classes/libp2p.html b/classes/libp2p.html index a6a5670d..16c7f724 100644 --- a/classes/libp2p.html +++ b/classes/libp2p.html @@ -3,8 +3,8 @@ - Libp2p | libp2p - v0.31.5 - + Libp2p | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • Libp2p @@ -326,6 +326,7 @@
    • stop
    • unhandle
    • create
      • +
    • getEventListener
    • listenerCount
    • on
    • once
      • @@ -552,7 +553,7 @@ @@ -563,7 +564,7 @@
      @@ -579,7 +580,7 @@ @@ -590,7 +591,7 @@
      @@ -844,7 +845,7 @@

      Parameters

      @@ -1000,7 +1001,7 @@

      Returns (string | symbol)[]

      @@ -1018,7 +1019,7 @@

      Returns number

      @@ -1135,7 +1136,7 @@

      Parameters

      @@ -1159,7 +1160,7 @@

      Parameters

      @@ -1210,7 +1211,7 @@

      Parameters

      @@ -1255,7 +1256,7 @@

      Parameters

      @@ -1300,7 +1301,7 @@

      Parameters

      @@ -1376,7 +1377,7 @@

      Parameters

      @@ -1421,7 +1422,7 @@

      Parameters

      @@ -1466,7 +1467,7 @@

      Parameters

      @@ -1490,7 +1491,7 @@

      Parameters

      @@ -1514,7 +1515,7 @@

      Parameters

      @@ -1559,7 +1560,7 @@

      Parameters

      @@ -1683,6 +1684,38 @@
    +
    + +

    Static getEventListener

    +
      +
    • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
      • +
    +
      +
    • + +
      +
      +

      Returns a list listener for a specific emitter event name.

      +
      +
      +

      Parameters

      +
        +
      • +
        emitter: DOMEventTarget | EventEmitter
        +
        • +
      • +
        name: string | symbol
        +
        • +
      +

      Returns Function[]

      +
      • +
    +

    Static listenerCount

    @@ -2008,6 +2041,9 @@
  • create
    • +
  • + getEventListener +
  • listenerCount
    • diff --git a/index.html b/index.html index c298c533..a5ce3f63 100644 --- a/index.html +++ b/index.html @@ -3,8 +3,8 @@ - libp2p - v0.31.5 - + libp2p - v0.31.6 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -50,7 +50,7 @@
    -

    libp2p - v0.31.5

    +

    libp2p - v0.31.6

    diff --git a/interfaces/constructoroptions.html b/interfaces/constructoroptions.html index 29413898..58e2dd63 100644 --- a/interfaces/constructoroptions.html +++ b/interfaces/constructoroptions.html @@ -3,8 +3,8 @@ - constructorOptions | libp2p - v0.31.5 - + constructorOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • constructorOptions diff --git a/interfaces/createoptions.html b/interfaces/createoptions.html index ee5bf143..b89b2375 100644 --- a/interfaces/createoptions.html +++ b/interfaces/createoptions.html @@ -3,8 +3,8 @@ - CreateOptions | libp2p - v0.31.5 - + CreateOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • CreateOptions diff --git a/interfaces/dhtoptions.html b/interfaces/dhtoptions.html index e5c2409a..dd11141c 100644 --- a/interfaces/dhtoptions.html +++ b/interfaces/dhtoptions.html @@ -3,8 +3,8 @@ - DhtOptions | libp2p - v0.31.5 - + DhtOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • DhtOptions diff --git a/interfaces/handlerprops.html b/interfaces/handlerprops.html index 07867dcb..7b454b88 100644 --- a/interfaces/handlerprops.html +++ b/interfaces/handlerprops.html @@ -3,8 +3,8 @@ - HandlerProps | libp2p - v0.31.5 - + HandlerProps | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • HandlerProps diff --git a/interfaces/keychainoptions.html b/interfaces/keychainoptions.html index 84321888..9a52ed7b 100644 --- a/interfaces/keychainoptions.html +++ b/interfaces/keychainoptions.html @@ -3,8 +3,8 @@ - KeychainOptions | libp2p - v0.31.5 - + KeychainOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • KeychainOptions diff --git a/interfaces/libp2pconfig.html b/interfaces/libp2pconfig.html index df6450b4..a7acf564 100644 --- a/interfaces/libp2pconfig.html +++ b/interfaces/libp2pconfig.html @@ -3,8 +3,8 @@ - Libp2pConfig | libp2p - v0.31.5 - + Libp2pConfig | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • Libp2pConfig diff --git a/interfaces/libp2pmodules.html b/interfaces/libp2pmodules.html index f1a5ff63..6c8cdbb8 100644 --- a/interfaces/libp2pmodules.html +++ b/interfaces/libp2pmodules.html @@ -3,8 +3,8 @@ - Libp2pModules | libp2p - v0.31.5 - + Libp2pModules | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • Libp2pModules diff --git a/interfaces/libp2poptions.html b/interfaces/libp2poptions.html index 655722f7..5c289f01 100644 --- a/interfaces/libp2poptions.html +++ b/interfaces/libp2poptions.html @@ -3,8 +3,8 @@ - Libp2pOptions | libp2p - v0.31.5 - + Libp2pOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • Libp2pOptions diff --git a/interfaces/metricsoptions.html b/interfaces/metricsoptions.html index f0adf2d5..8b8d3247 100644 --- a/interfaces/metricsoptions.html +++ b/interfaces/metricsoptions.html @@ -3,8 +3,8 @@ - MetricsOptions | libp2p - v0.31.5 - + MetricsOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • MetricsOptions diff --git a/interfaces/peerstoreoptions.html b/interfaces/peerstoreoptions.html index e1089ecd..6c3f7681 100644 --- a/interfaces/peerstoreoptions.html +++ b/interfaces/peerstoreoptions.html @@ -3,8 +3,8 @@ - PeerStoreOptions | libp2p - v0.31.5 - + PeerStoreOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • PeerStoreOptions diff --git a/interfaces/pubsublocaloptions.html b/interfaces/pubsublocaloptions.html index 23090afe..36e8365f 100644 --- a/interfaces/pubsublocaloptions.html +++ b/interfaces/pubsublocaloptions.html @@ -3,8 +3,8 @@ - PubsubLocalOptions | libp2p - v0.31.5 - + PubsubLocalOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • PubsubLocalOptions diff --git a/interfaces/randomwalkoptions.html b/interfaces/randomwalkoptions.html index 1cc97355..d271c8c8 100644 --- a/interfaces/randomwalkoptions.html +++ b/interfaces/randomwalkoptions.html @@ -3,8 +3,8 @@ - RandomWalkOptions | libp2p - v0.31.5 - + RandomWalkOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • RandomWalkOptions diff --git a/interfaces/relayoptions.html b/interfaces/relayoptions.html index 33e1974e..a33acf8a 100644 --- a/interfaces/relayoptions.html +++ b/interfaces/relayoptions.html @@ -3,8 +3,8 @@ - RelayOptions | libp2p - v0.31.5 - + RelayOptions | libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -52,7 +52,7 @@
    • - libp2p - v0.31.5 + libp2p - v0.31.6
    • RelayOptions diff --git a/modules.html b/modules.html index 3d7e7ef6..56faa9e5 100644 --- a/modules.html +++ b/modules.html @@ -3,8 +3,8 @@ - libp2p - v0.31.5 - + libp2p - v0.31.6 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - libp2p - v0.31.5 + libp2p - v0.31.6
    @@ -50,7 +50,7 @@
    -

    libp2p - v0.31.5

    +

    libp2p - v0.31.6