From 572dbab2707a1f7955c9faa2ea0b3d456524c866 Mon Sep 17 00:00:00 2001 From: Jacob Heun Date: Fri, 12 Jun 2020 16:48:44 +0200 Subject: [PATCH] chore: update documentation --- assets/anchor.js | 16 +- assets/site.js | 14 +- index.html | 2655 ++++++++++++++++++++++++---------------------- 3 files changed, 1385 insertions(+), 1300 deletions(-) diff --git a/assets/anchor.js b/assets/anchor.js index f74c2de7..1f573dcb 100644 --- a/assets/anchor.js +++ b/assets/anchor.js @@ -6,7 +6,7 @@ /* eslint-env amd, node */ // https://github.com/umdjs/umd/blob/master/templates/returnExports.js -(function(root, factory) { +(function (root, factory) { 'use strict'; if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. @@ -21,7 +21,7 @@ root.AnchorJS = factory(); root.anchors = new root.AnchorJS(); } -})(this, function() { +})(this, function () { 'use strict'; function AnchorJS(options) { this.options = options || {}; @@ -51,7 +51,7 @@ * https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40 * @returns {Boolean} - true if the current device supports touch. */ - this.isTouchDevice = function() { + this.isTouchDevice = function () { return !!( 'ontouchstart' in window || (window.DocumentTouch && document instanceof DocumentTouch) @@ -64,7 +64,7 @@ * to. Also accepts an array or nodeList containing the relavant elements. * @returns {this} - The AnchorJS object */ - this.add = function(selector) { + this.add = function (selector) { var elements, elsWithIds, idList, @@ -193,7 +193,7 @@ * OR a nodeList / array containing the DOM elements. * @returns {this} - The AnchorJS object */ - this.remove = function(selector) { + this.remove = function (selector) { var index, domAnchor, elements = _getElements(selector); @@ -216,7 +216,7 @@ /** * Removes all anchorjs links. Mostly used for tests. */ - this.removeAll = function() { + this.removeAll = function () { this.remove(this.elements); }; @@ -229,7 +229,7 @@ * @param {String} text - Any text. Usually pulled from the webpage element we are linking to. * @returns {String} - hyphen-delimited text for use in IDs and URLs. */ - this.urlify = function(text) { + this.urlify = function (text) { // Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\ var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g, urlText; @@ -260,7 +260,7 @@ * @param {HTMLElemnt} el - a DOM node * @returns {Boolean} true/false */ - this.hasAnchorJSLink = function(el) { + this.hasAnchorJSLink = function (el) { var hasLeftAnchor = el.firstChild && (' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1, diff --git a/assets/site.js b/assets/site.js index f86584f2..a624be7b 100644 --- a/assets/site.js +++ b/assets/site.js @@ -7,7 +7,7 @@ anchors.add('h3'); // Filter UI var tocElements = document.getElementById('toc').getElementsByTagName('li'); -document.getElementById('filter-input').addEventListener('keyup', function(e) { +document.getElementById('filter-input').addEventListener('keyup', function (e) { var i, element, children; // enter key @@ -22,14 +22,14 @@ document.getElementById('filter-input').addEventListener('keyup', function(e) { } } - var match = function() { + var match = function () { return true; }; var value = this.value.toLowerCase(); if (!value.match(/^\s*$/)) { - match = function(element) { + match = function (element) { var html = element.firstChild.innerHTML; return html && html.toLowerCase().indexOf(value) !== -1; }; @@ -114,12 +114,12 @@ var cw_without_sb = split_left.clientWidth; split_left.style.overflow = ''; Split(['#split-left', '#split-right'], { - elementStyle: function(dimension, size, gutterSize) { + elementStyle: function (dimension, size, gutterSize) { return { 'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)' }; }, - gutterStyle: function(dimension, gutterSize) { + gutterStyle: function (dimension, gutterSize) { return { 'flex-basis': gutterSize + 'px' }; @@ -152,9 +152,9 @@ function loadState(ev) { } } -window.addEventListener('load', function() { +window.addEventListener('load', function () { // Restore after Firefox scrolls to hash. - setTimeout(function() { + setTimeout(function () { loadState(); // Update with initial scroll position. updateState(); diff --git a/index.html b/index.html index f84937b8..e119ab01 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - libp2p 0.28.0 | Documentation + libp2p 0.28.1 | Documentation @@ -15,7 +15,7 @@

libp2p

-
0.28.0
+
0.28.1
+
  • + #getAll +
    • + @@ -1386,52 +1392,6 @@ -
  • - Book - ▸ - - - - -
    • - -
  • @@ -1546,6 +1506,52 @@
    • +
  • + Book + ▸ + + + + +
    • + +
  • @@ -1861,7 +1867,7 @@ - + src/index.js @@ -1930,7 +1936,7 @@
    - + src/index.js @@ -2020,7 +2026,7 @@ instance if one is not provided in options.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/connection-manager/index.js @@ -5161,6 +5167,85 @@ will be disconnected first.

    + + +
    +
    + +
    +
    +
    + ▸ + getAll(peerId) +
    +
    + @@ -5188,7 +5273,7 @@ will be disconnected first.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/circuit/circuit/hop.js @@ -6687,7 +6772,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6762,7 +6847,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/utils.js @@ -6838,7 +6923,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -6941,7 +7026,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7003,7 +7088,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7071,7 +7156,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7133,7 +7218,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/circuit/circuit/stream-handler.js @@ -7195,7 +7280,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7383,7 +7468,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7437,7 +7522,7 @@ peer. A new, virtual, connection will be created between the two via the relay.< - + src/dialer/index.js @@ -7549,7 +7634,7 @@ will be used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/peer-store/proto-book.js @@ -13490,6 +13575,1065 @@ 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
    + + + + + + + + + + + + + + + + + + + + @@ -13514,7 +14658,7 @@ will include the encapsulated PeerId of the peer.

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

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

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

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

    - + src/peer-store/book.js @@ -13919,1065 +15063,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
    - - - - - - - - - - - - - - - - - - - - - - - @@ -14999,7 +15084,7 @@ protocols of a peer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    - + src/identify/index.js