From bc22478650620360a5710925a635b37c74495850 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Sun, 18 Aug 2024 07:48:26 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- ..._libp2p_crypto.keys.Ed25519PrivateKey.html | 8 +-- .../_libp2p_crypto.keys.Ed25519PublicKey.html | 4 +- .../_libp2p_crypto.keys.RsaPrivateKey.html | 8 +-- classes/_libp2p_crypto.keys.RsaPublicKey.html | 4 +- ...ibp2p_crypto.keys.Secp256k1PrivateKey.html | 8 +-- ...libp2p_crypto.keys.Secp256k1PublicKey.html | 4 +- classes/_libp2p_floodsub.FloodSub.html | 18 ++--- classes/_libp2p_interface.AbortError.html | 6 +- .../_libp2p_interface.AggregateCodeError.html | 4 +- classes/_libp2p_interface.CodeError.html | 4 +- ..._interface.InvalidCryptoExchangeError.html | 4 +- ...erface.InvalidCryptoTransmissionError.html | 4 +- .../_libp2p_interface.TypedEventEmitter.html | 6 +- ..._libp2p_interface.UnexpectedPeerError.html | 4 +- .../_libp2p_peer_collections.PeerFilter.html | 4 +- .../_libp2p_peer_collections.PeerList.html | 4 +- classes/_libp2p_peer_collections.PeerMap.html | 4 +- classes/_libp2p_peer_collections.PeerSet.html | 4 +- classes/_libp2p_peer_record.PeerRecord.html | 10 +-- .../_libp2p_peer_record.RecordEnvelope.html | 16 ++--- ...libp2p_peer_store.PersistentPeerStore.html | 22 +++--- ...ibp2p_pubsub.index.PubSubBaseProtocol.html | 72 +++++++++---------- ...ibp2p_pubsub.peer_streams.PeerStreams.html | 26 +++---- classes/_libp2p_record.Libp2pRecord.html | 10 +-- ..._utils.abstract_stream.AbstractStream.html | 52 +++++++------- ...tils.adaptive_timeout.AdaptiveTimeout.html | 4 +- .../_libp2p_utils.filters.BloomFilter.html | 10 +-- .../_libp2p_utils.filters.CuckooFilter.html | 4 +- ...2p_utils.filters.ScalableCuckooFilter.html | 4 +- ...2p_utils.moving_average.MovingAverage.html | 4 +- .../_libp2p_utils.peer_queue.PeerQueue.html | 26 +++---- ...2p_utils.priority_queue.PriorityQueue.html | 24 +++---- classes/_libp2p_utils.queue.Queue.html | 26 +++---- ...libp2p_utils.rate_limiter.RateLimiter.html | 6 +- ..._libp2p_crypto.keys.keysPBM.KeyType-1.html | 4 +- enums/_libp2p_interface.FaultTolerance.html | 6 +- ...libp2p_interface.TopicValidatorResult.html | 8 +-- enums/_libp2p_kad_dht.EventTypes.html | 4 +- enums/_libp2p_kad_dht.MessageType-1.html | 4 +- functions/_libp2p_autonat.autoNAT.html | 2 +- functions/_libp2p_bootstrap.bootstrap.html | 2 +- ...p_circuit_relay_v2.circuitRelayServer.html | 2 +- ...ircuit_relay_v2.circuitRelayTransport.html | 2 +- functions/_libp2p_crypto.hmac.create.html | 2 +- functions/_libp2p_crypto.index.pbkdf2.html | 2 +- .../_libp2p_crypto.index.randomBytes.html | 2 +- ..._crypto.keys.generateEphemeralKeyPair.html | 2 +- .../_libp2p_crypto.keys.generateKeyPair.html | 2 +- ...p_crypto.keys.generateKeyPairFromSeed.html | 2 +- functions/_libp2p_crypto.keys.importKey.html | 2 +- .../_libp2p_crypto.keys.keyStretcher.html | 2 +- ...p2p_crypto.keys.keysPBM.KeyType.codec.html | 2 +- ..._crypto.keys.keysPBM.PrivateKey.codec.html | 2 +- ...crypto.keys.keysPBM.PrivateKey.decode.html | 2 +- ...crypto.keys.keysPBM.PrivateKey.encode.html | 2 +- ...p_crypto.keys.keysPBM.PublicKey.codec.html | 2 +- ..._crypto.keys.keysPBM.PublicKey.decode.html | 2 +- ..._crypto.keys.keysPBM.PublicKey.encode.html | 2 +- ..._libp2p_crypto.keys.marshalPrivateKey.html | 2 +- .../_libp2p_crypto.keys.marshalPublicKey.html | 2 +- ...ibp2p_crypto.keys.unmarshalPrivateKey.html | 2 +- ...libp2p_crypto.keys.unmarshalPublicKey.html | 2 +- functions/_libp2p_dcutr.dcutr.html | 2 +- ...bp2p_devtools_metrics.devToolsMetrics.html | 2 +- functions/_libp2p_echo.echo-1.html | 2 +- functions/_libp2p_fetch.fetch-1.html | 2 +- functions/_libp2p_floodsub.floodsub-1.html | 2 +- functions/_libp2p_identify.identify-1.html | 2 +- .../_libp2p_identify.identifyPush-1.html | 2 +- functions/_libp2p_interface.isConnection.html | 2 +- functions/_libp2p_interface.isPeerId.html | 2 +- functions/_libp2p_interface.isStartable.html | 2 +- functions/_libp2p_interface.isTransport.html | 2 +- .../_libp2p_interface.setMaxListeners.html | 2 +- functions/_libp2p_interface.start.html | 2 +- functions/_libp2p_interface.stop.html | 2 +- ...e_compliance_tests.connection.default.html | 2 +- ...e_tests.connection_encryption.default.html | 2 +- ...iance_tests.is_valid_tick.isValidTick.html | 2 +- ...pliance_tests.matchers.matchMultiaddr.html | 2 +- ...compliance_tests.matchers.matchPeerId.html | 2 +- ...compliance_tests.mocks.connectionPair.html | 2 +- ...compliance_tests.mocks.mockConnection.html | 2 +- ...iance_tests.mocks.mockConnectionGater.html | 2 +- ...nce_tests.mocks.mockConnectionManager.html | 2 +- ...ace_compliance_tests.mocks.mockDuplex.html | 2 +- ...ce_compliance_tests.mocks.mockMetrics.html | 2 +- ...nce_tests.mocks.mockMultiaddrConnPair.html | 2 +- ...e_tests.mocks.mockMultiaddrConnection.html | 2 +- ...face_compliance_tests.mocks.mockMuxer.html | 2 +- ..._compliance_tests.mocks.mockRegistrar.html | 2 +- ...ace_compliance_tests.mocks.mockStream.html | 2 +- ...e_compliance_tests.mocks.mockUpgrader.html | 2 +- ...ace_compliance_tests.mocks.streamPair.html | 2 +- ...mpliance_tests.peer_discovery.default.html | 2 +- ...rface_compliance_tests.pubsub.default.html | 2 +- ...compliance_tests.stream_muxer.default.html | 2 +- ...ce_compliance_tests.transport.default.html | 2 +- .../_libp2p_kad_dht.MessageType.codec.html | 2 +- functions/_libp2p_kad_dht.kadDHT-1.html | 2 +- .../_libp2p_kad_dht.passthroughMapper.html | 2 +- ..._kad_dht.removePrivateAddressesMapper.html | 2 +- ...p_kad_dht.removePublicAddressesMapper.html | 2 +- functions/_libp2p_keychain.keychain-1.html | 2 +- functions/_libp2p_logger.defaultLogger.html | 2 +- functions/_libp2p_logger.disable.html | 2 +- functions/_libp2p_logger.enable.html | 2 +- functions/_libp2p_logger.enabled.html | 2 +- functions/_libp2p_logger.logger-1.html | 2 +- functions/_libp2p_logger.peerLogger.html | 2 +- functions/_libp2p_logger.prefixLogger.html | 2 +- functions/_libp2p_mdns.mdns.html | 2 +- functions/_libp2p_mplex.mplex.html | 2 +- .../_libp2p_multistream_select.handle.html | 2 +- .../_libp2p_multistream_select.select.html | 2 +- ..._libp2p_peer_collections.peerFilter-1.html | 2 +- .../_libp2p_peer_collections.peerList-1.html | 2 +- .../_libp2p_peer_collections.peerMap-1.html | 2 +- .../_libp2p_peer_collections.peerSet-1.html | 2 +- ...bp2p_peer_collections.trackedPeerList.html | 2 +- ...ibp2p_peer_collections.trackedPeerMap.html | 2 +- ...ibp2p_peer_collections.trackedPeerSet.html | 2 +- functions/_libp2p_peer_id.createPeerId.html | 2 +- .../_libp2p_peer_id.peerIdFromBytes.html | 2 +- functions/_libp2p_peer_id.peerIdFromCID.html | 2 +- functions/_libp2p_peer_id.peerIdFromKeys.html | 2 +- .../_libp2p_peer_id.peerIdFromPeerId.html | 2 +- .../_libp2p_peer_id.peerIdFromString.html | 2 +- ...p_peer_id_factory.createEd25519PeerId.html | 2 +- ...libp2p_peer_id_factory.createFromJSON.html | 2 +- ...p2p_peer_id_factory.createFromPrivKey.html | 2 +- ...2p_peer_id_factory.createFromProtobuf.html | 2 +- ...bp2p_peer_id_factory.createFromPubKey.html | 2 +- ...ibp2p_peer_id_factory.createRSAPeerId.html | 2 +- ...peer_id_factory.createSecp256k1PeerId.html | 2 +- ...bp2p_peer_id_factory.exportToProtobuf.html | 2 +- functions/_libp2p_perf.perf-1.html | 2 +- functions/_libp2p_ping.ping.html | 2 +- functions/_libp2p_plaintext.plaintext.html | 2 +- functions/_libp2p_pnet.generateKey.html | 2 +- functions/_libp2p_pnet.preSharedKey.html | 2 +- ..._prometheus_metrics.prometheusMetrics.html | 2 +- functions/_libp2p_pubsub.utils.anyMatch.html | 2 +- .../_libp2p_pubsub.utils.bigIntFromBytes.html | 2 +- .../_libp2p_pubsub.utils.bigIntToBytes.html | 2 +- .../_libp2p_pubsub.utils.ensureArray.html | 2 +- functions/_libp2p_pubsub.utils.msgId.html | 2 +- .../_libp2p_pubsub.utils.noSignMsgId.html | 2 +- .../_libp2p_pubsub.utils.randomSeqno.html | 2 +- functions/_libp2p_pubsub.utils.toMessage.html | 2 +- .../_libp2p_pubsub.utils.toRpcMessage.html | 2 +- .../_libp2p_simple_metrics.simpleMetrics.html | 2 +- functions/_libp2p_tcp.tcp.html | 2 +- functions/_libp2p_tls.tls.html | 2 +- functions/_libp2p_upnp_nat.uPnPNAT-1.html | 2 +- ...ls.abort_options.createTimeoutOptions.html | 2 +- ....address_sort.certifiedAddressesFirst.html | 2 +- ...ddress_sort.circuitRelayAddressesLast.html | 2 +- ...utils.address_sort.defaultAddressSort.html | 2 +- ...ils.address_sort.publicAddressesFirst.html | 2 +- ...libp2p_utils.array_equals.arrayEquals.html | 2 +- ...s.close.safelyCloseConnectionIfUnused.html | 2 +- ..._libp2p_utils.close.safelyCloseStream.html | 2 +- ...libp2p_utils.close_source.closeSource.html | 2 +- ...ibp2p_utils.filters.createBloomFilter.html | 2 +- ...bp2p_utils.filters.createCuckooFilter.html | 2 +- ...ls.filters.createScalableCuckooFilter.html | 2 +- ...p_port_to_multiaddr.ipPortToMultiaddr.html | 2 +- .../_libp2p_utils.is_promise.isPromise.html | 2 +- ...tils.multiaddr_is_loopback.isLoopback.html | 2 +- ..._utils.multiaddr_is_private.isPrivate.html | 2 +- .../_libp2p_utils.private_ip.isPrivateIp.html | 2 +- ...tream_to_ma_conn.streamToMaConnection.html | 2 +- ...libp2p_utils.tracked_list.trackedList.html | 2 +- .../_libp2p_utils.tracked_map.trackedMap.html | 2 +- functions/_libp2p_webrtc.webRTC.html | 2 +- functions/_libp2p_webrtc.webRTCDirect.html | 2 +- functions/_libp2p_websockets.filters.all.html | 2 +- ..._libp2p_websockets.filters.dnsWsOrWss.html | 2 +- .../_libp2p_websockets.filters.dnsWss.html | 2 +- functions/_libp2p_websockets.filters.wss.html | 2 +- .../_libp2p_websockets.index.webSockets.html | 2 +- .../_libp2p_webtransport.webTransport.html | 2 +- functions/libp2p.index.createLibp2p.html | 2 +- .../_libp2p_autonat.AutoNATComponents.html | 4 +- .../_libp2p_autonat.AutoNATServiceInit.html | 14 ++-- ..._libp2p_bootstrap.BootstrapComponents.html | 4 +- .../_libp2p_bootstrap.BootstrapInit.html | 12 ++-- ..._circuit_relay_v2.CircuitRelayService.html | 4 +- ...it_relay_v2.CircuitRelayServiceEvents.html | 4 +- ...p2p_circuit_relay_v2.RelayReservation.html | 4 +- interfaces/_libp2p_crypto.hmac.HMAC.html | 4 +- .../_libp2p_crypto.keys.JWKKeyPair.html | 4 +- ...bp2p_crypto.keys.keysPBM.PrivateKey-1.html | 4 +- ...ibp2p_crypto.keys.keysPBM.PublicKey-1.html | 4 +- .../_libp2p_dcutr.DCUtRServiceComponents.html | 4 +- .../_libp2p_dcutr.DCUtRServiceInit.html | 10 +-- .../_libp2p_devtools_metrics.Address.html | 8 +-- ...vtools_metrics.CopyToClipboardMessage.html | 4 +- ...ibp2p_devtools_metrics.DevToolsEvents.html | 8 +-- ...ols_metrics.DevToolsMetricsComponents.html | 4 +- ..._devtools_metrics.DevToolsMetricsInit.html | 4 +- .../_libp2p_devtools_metrics.DevToolsRPC.html | 4 +- .../_libp2p_devtools_metrics.MetricsRPC.html | 14 ++-- .../_libp2p_devtools_metrics.NodeAddress.html | 4 +- .../_libp2p_devtools_metrics.NodeStatus.html | 4 +- ...2p_devtools_metrics.PageLoadedMessage.html | 4 +- interfaces/_libp2p_devtools_metrics.Peer.html | 12 ++-- .../_libp2p_devtools_metrics.PeerAddress.html | 4 +- ...tools_metrics.PermissionsErrorMessage.html | 4 +- .../_libp2p_devtools_metrics.RPCMessage.html | 4 +- interfaces/_libp2p_echo.Echo.html | 4 +- interfaces/_libp2p_echo.EchoComponents.html | 4 +- interfaces/_libp2p_echo.EchoInit.html | 4 +- interfaces/_libp2p_fetch.Fetch.html | 8 +-- interfaces/_libp2p_fetch.FetchComponents.html | 4 +- interfaces/_libp2p_fetch.FetchInit.html | 6 +- interfaces/_libp2p_fetch.LookupFunction.html | 2 +- .../_libp2p_floodsub.FloodSubComponents.html | 2 +- interfaces/_libp2p_floodsub.FloodSubInit.html | 4 +- interfaces/_libp2p_identify.Identify.html | 4 +- .../_libp2p_identify.IdentifyComponents.html | 4 +- interfaces/_libp2p_identify.IdentifyInit.html | 20 +++--- interfaces/_libp2p_identify.IdentifyPush.html | 4 +- ...ibp2p_identify.IdentifyPushComponents.html | 4 +- .../_libp2p_identify.IdentifyPushInit.html | 22 +++--- .../_libp2p_interface.AbortOptions.html | 4 +- interfaces/_libp2p_interface.Address.html | 6 +- .../_libp2p_interface.AddressSorter.html | 2 +- ...p2p_interface.CalculatedMetricOptions.html | 8 +-- .../_libp2p_interface.ComponentLogger.html | 4 +- interfaces/_libp2p_interface.Connection.html | 34 ++++----- ..._libp2p_interface.ConnectionEncrypter.html | 8 +-- .../_libp2p_interface.ConnectionGater.html | 26 +++---- .../_libp2p_interface.ConnectionHandler.html | 2 +- ..._libp2p_interface.ConnectionProtector.html | 4 +- .../_libp2p_interface.ConnectionTimeline.html | 8 +-- .../_libp2p_interface.ContentRouting.html | 10 +-- ...bp2p_interface.ContentRoutingProvider.html | 4 +- interfaces/_libp2p_interface.Counter.html | 6 +- .../_libp2p_interface.CounterGroup.html | 6 +- ...ibp2p_interface.CreateListenerOptions.html | 4 +- interfaces/_libp2p_interface.DialOptions.html | 4 +- ..._libp2p_interface.DialProtocolOptions.html | 8 +-- ...libp2p_interface.DialTransportOptions.html | 4 +- .../_libp2p_interface.Ed25519PeerId.html | 4 +- interfaces/_libp2p_interface.Envelope.html | 4 +- .../_libp2p_interface.EventCallback.html | 2 +- interfaces/_libp2p_interface.EventObject.html | 4 +- .../_libp2p_interface.IdentifyResult.html | 20 +++--- .../_libp2p_interface.IncomingStreamData.html | 4 +- .../_libp2p_interface.IsDialableOptions.html | 4 +- interfaces/_libp2p_interface.Libp2p.html | 58 +++++++-------- .../_libp2p_interface.Libp2pEvents.html | 28 ++++---- interfaces/_libp2p_interface.Listener.html | 10 +-- .../_libp2p_interface.ListenerEvents.html | 4 +- interfaces/_libp2p_interface.Logger.html | 4 +- .../_libp2p_interface.LoggerOptions.html | 4 +- interfaces/_libp2p_interface.Metric.html | 12 ++-- interfaces/_libp2p_interface.MetricGroup.html | 12 ++-- .../_libp2p_interface.MetricOptions.html | 6 +- interfaces/_libp2p_interface.Metrics.html | 14 ++-- ..._libp2p_interface.MultiaddrConnection.html | 12 ++-- ...interface.MultiaddrConnectionTimeline.html | 8 +-- .../_libp2p_interface.MultiaddrFilter.html | 2 +- .../_libp2p_interface.NewStreamOptions.html | 8 +-- interfaces/_libp2p_interface.NodeInfo.html | 6 +- interfaces/_libp2p_interface.Peer.html | 14 ++-- interfaces/_libp2p_interface.PeerData.html | 16 ++--- .../_libp2p_interface.PeerDiscovery.html | 6 +- ..._libp2p_interface.PeerDiscoveryEvents.html | 4 +- ...ibp2p_interface.PeerDiscoveryProvider.html | 4 +- interfaces/_libp2p_interface.PeerId.html | 4 +- interfaces/_libp2p_interface.PeerInfo.html | 6 +- interfaces/_libp2p_interface.PeerQuery.html | 4 +- .../_libp2p_interface.PeerQueryFilter.html | 2 +- .../_libp2p_interface.PeerQueryOrder.html | 2 +- interfaces/_libp2p_interface.PeerRouting.html | 6 +- ..._libp2p_interface.PeerRoutingProvider.html | 4 +- interfaces/_libp2p_interface.PeerStore.html | 20 +++--- .../_libp2p_interface.PeerStreamEvents.html | 4 +- interfaces/_libp2p_interface.PeerStreams.html | 6 +- interfaces/_libp2p_interface.PeerUpdate.html | 4 +- interfaces/_libp2p_interface.PendingDial.html | 10 +-- interfaces/_libp2p_interface.PrivateKey.html | 8 +-- interfaces/_libp2p_interface.PubSub.html | 20 +++--- .../_libp2p_interface.PubSubEvents.html | 4 +- interfaces/_libp2p_interface.PubSubInit.html | 14 ++-- interfaces/_libp2p_interface.PubSubRPC.html | 4 +- .../_libp2p_interface.PubSubRPCMessage.html | 4 +- ...ibp2p_interface.PubSubRPCSubscription.html | 4 +- interfaces/_libp2p_interface.PublicKey.html | 4 +- .../_libp2p_interface.PublishResult.html | 4 +- interfaces/_libp2p_interface.RSAPeerId.html | 4 +- interfaces/_libp2p_interface.Record.html | 10 +-- .../_libp2p_interface.RoutingOptions.html | 8 +-- .../_libp2p_interface.Secp256k1PeerId.html | 4 +- .../_libp2p_interface.SecuredConnection.html | 4 +- .../_libp2p_interface.SignedMessage.html | 4 +- .../_libp2p_interface.SignedPeerRecord.html | 4 +- interfaces/_libp2p_interface.Startable.html | 14 ++-- interfaces/_libp2p_interface.StopTimer.html | 2 +- interfaces/_libp2p_interface.Stream.html | 28 ++++---- .../_libp2p_interface.StreamHandler.html | 2 +- ...libp2p_interface.StreamHandlerOptions.html | 8 +-- ..._libp2p_interface.StreamHandlerRecord.html | 4 +- interfaces/_libp2p_interface.StreamMuxer.html | 12 ++-- .../_libp2p_interface.StreamMuxerFactory.html | 6 +- .../_libp2p_interface.StreamMuxerInit.html | 8 +-- .../_libp2p_interface.StreamTimeline.html | 14 ++-- ...bp2p_interface.SubscriptionChangeData.html | 4 +- interfaces/_libp2p_interface.Tag.html | 4 +- interfaces/_libp2p_interface.TagOptions.html | 6 +- .../_libp2p_interface.TopicValidatorFn.html | 2 +- interfaces/_libp2p_interface.Topology.html | 10 +-- .../_libp2p_interface.TopologyFilter.html | 4 +- interfaces/_libp2p_interface.Transport.html | 14 ++-- .../_libp2p_interface.TypedEventTarget.html | 6 +- interfaces/_libp2p_interface.URLPeerId.html | 4 +- .../_libp2p_interface.UnsignedMessage.html | 4 +- interfaces/_libp2p_interface.Upgrader.html | 6 +- .../_libp2p_interface.UpgraderOptions.html | 6 +- ...face_compliance_tests.index.TestSetup.html | 4 +- ...nce_tests.mocks.MockNetworkComponents.html | 4 +- ...mpliance_tests.mocks.MockUpgraderInit.html | 4 +- ...ce_compliance_tests.pubsub.PubSubArgs.html | 4 +- ...pliance_tests.pubsub.PubSubComponents.html | 4 +- ..._compliance_tests.transport.Connector.html | 4 +- ...tests.transport.TransportTestFixtures.html | 4 +- ...p2p_interface_internal.AddressManager.html | 16 ++--- ..._interface_internal.ConnectionManager.html | 18 ++--- .../_libp2p_interface_internal.Envelope.html | 4 +- ...interface_internal.IncomingStreamData.html | 6 +- ...erface_internal.OpenConnectionOptions.html | 6 +- ..._libp2p_interface_internal.RandomWalk.html | 4 +- .../_libp2p_interface_internal.Record.html | 10 +-- .../_libp2p_interface_internal.Registrar.html | 16 ++--- ...bp2p_interface_internal.StreamHandler.html | 2 +- ...terface_internal.StreamHandlerOptions.html | 8 +-- ...nterface_internal.StreamHandlerRecord.html | 6 +- ...p_interface_internal.TransportManager.html | 22 +++--- ..._internal.TransportManagerDialOptions.html | 2 +- interfaces/_libp2p_kad_dht.AddPeerEvent.html | 4 +- interfaces/_libp2p_kad_dht.DHTRecord.html | 4 +- interfaces/_libp2p_kad_dht.DialPeerEvent.html | 4 +- .../_libp2p_kad_dht.FinalPeerEvent.html | 4 +- interfaces/_libp2p_kad_dht.KadDHT.html | 20 +++--- .../_libp2p_kad_dht.KadDHTComponents.html | 4 +- interfaces/_libp2p_kad_dht.KadDHTInit.html | 38 +++++----- .../_libp2p_kad_dht.PeerInfoMapper.html | 2 +- .../_libp2p_kad_dht.PeerResponseEvent.html | 4 +- interfaces/_libp2p_kad_dht.ProviderEvent.html | 4 +- .../_libp2p_kad_dht.QueryErrorEvent.html | 4 +- interfaces/_libp2p_kad_dht.RoutingTable.html | 4 +- interfaces/_libp2p_kad_dht.SelectFn.html | 2 +- .../_libp2p_kad_dht.SendQueryEvent.html | 4 +- interfaces/_libp2p_kad_dht.SingleKadDHT.html | 22 +++--- interfaces/_libp2p_kad_dht.ValidateFn.html | 2 +- interfaces/_libp2p_kad_dht.ValueEvent.html | 4 +- interfaces/_libp2p_keychain.DEKConfig.html | 4 +- interfaces/_libp2p_keychain.KeyInfo.html | 6 +- interfaces/_libp2p_keychain.Keychain.html | 24 +++---- .../_libp2p_keychain.KeychainComponents.html | 4 +- interfaces/_libp2p_keychain.KeychainInit.html | 4 +- .../_libp2p_logger.ComponentLogger.html | 4 +- interfaces/_libp2p_logger.Logger.html | 4 +- .../_libp2p_logger.PeerLoggerOptions.html | 4 +- interfaces/_libp2p_mplex.MplexInit.html | 14 ++-- ...tistream_select.MultistreamSelectInit.html | 4 +- ...p2p_multistream_select.ProtocolStream.html | 4 +- .../_libp2p_peer_record.PeerRecordInit.html | 6 +- ...libp2p_peer_record.RecordEnvelopeInit.html | 4 +- .../_libp2p_peer_store.AddressFilter.html | 2 +- ...r_store.PersistentPeerStoreComponents.html | 4 +- ...2p_peer_store.PersistentPeerStoreInit.html | 4 +- interfaces/_libp2p_perf.Perf.html | 4 +- interfaces/_libp2p_perf.PerfComponents.html | 4 +- interfaces/_libp2p_perf.PerfInit.html | 6 +- interfaces/_libp2p_perf.PerfOptions.html | 4 +- interfaces/_libp2p_perf.PerfOutput.html | 4 +- interfaces/_libp2p_ping.PingService.html | 4 +- .../_libp2p_ping.PingServiceComponents.html | 4 +- interfaces/_libp2p_ping.PingServiceInit.html | 6 +- ..._libp2p_plaintext.PlaintextComponents.html | 4 +- .../_libp2p_plaintext.PlaintextInit.html | 4 +- .../_libp2p_pnet.ProtectorComponents.html | 4 +- interfaces/_libp2p_pnet.ProtectorInit.html | 6 +- ...ics.PrometheusCalculatedMetricOptions.html | 4 +- ...s_metrics.PrometheusMetricsComponents.html | 4 +- ...metheus_metrics.PrometheusMetricsInit.html | 10 +-- ..._libp2p_pubsub.index.PubSubComponents.html | 4 +- ...ub.peer_streams.PeerStreamsComponents.html | 4 +- ...p_pubsub.peer_streams.PeerStreamsInit.html | 4 +- .../_libp2p_simple_metrics.OnMetrics.html | 2 +- ...bp2p_simple_metrics.SimpleMetricsInit.html | 6 +- interfaces/_libp2p_tcp.TCPComponents.html | 4 +- .../_libp2p_tcp.TCPCreateListenerOptions.html | 10 +-- interfaces/_libp2p_tcp.TCPDialOptions.html | 10 +-- interfaces/_libp2p_tcp.TCPMetrics.html | 4 +- interfaces/_libp2p_tcp.TCPOptions.html | 18 ++--- interfaces/_libp2p_tcp.TCPSocketOptions.html | 10 +-- interfaces/_libp2p_tls.TLSComponents.html | 4 +- interfaces/_libp2p_tls.TLSInit.html | 4 +- interfaces/_libp2p_upnp_nat.PMPOptions.html | 4 +- interfaces/_libp2p_upnp_nat.UPnPNAT.html | 4 +- .../_libp2p_upnp_nat.UPnPNATComponents.html | 4 +- interfaces/_libp2p_upnp_nat.UPnPNATInit.html | 14 ++-- ...ls.abstract_stream.AbstractStreamInit.html | 24 +++---- ....adaptive_timeout.AdaptiveTimeoutInit.html | 4 +- ...daptive_timeout.AdaptiveTimeoutSignal.html | 4 +- ...ptive_timeout.GetTimeoutSignalOptions.html | 4 +- ...ls.close.SafelyCloseConnectionOptions.html | 4 +- ...bp2p_utils.filters.BloomFilterOptions.html | 4 +- ...libp2p_utils.filters.CuckooFilterInit.html | 12 ++-- interfaces/_libp2p_utils.filters.Filter.html | 4 +- ...tils.filters.ScalableCuckooFilterInit.html | 14 ++-- ..._utils.peer_queue.PeerQueueJobOptions.html | 4 +- ...riority_queue.PriorityQueueJobOptions.html | 4 +- .../_libp2p_utils.queue.Comparator.html | 2 +- .../_libp2p_utils.queue.JobMatcher.html | 2 +- .../_libp2p_utils.queue.QueueEvents.html | 20 +++--- interfaces/_libp2p_utils.queue.QueueInit.html | 10 +-- .../_libp2p_utils.queue.QueueJobFailure.html | 4 +- .../_libp2p_utils.queue.QueueJobSuccess.html | 4 +- .../_libp2p_utils.queue.RunFunction.html | 2 +- ...rate_limiter.GetKeySecDurationOptions.html | 4 +- ...2p_utils.rate_limiter.RateLimiterInit.html | 14 ++-- ..._utils.rate_limiter.RateLimiterResult.html | 4 +- ..._libp2p_utils.rate_limiter.RateRecord.html | 4 +- ...ls.stream_to_ma_conn.StreamProperties.html | 4 +- ...ls.tracked_list.CreateTrackedListInit.html | 6 +- ...tils.tracked_map.CreateTrackedMapInit.html | 6 +- ...bp2p_utils.tracked_map.TrackedMapInit.html | 4 +- .../_libp2p_webrtc.DataChannelOptions.html | 14 ++-- ...websockets.index.WebSocketsComponents.html | 4 +- ...ibp2p_websockets.index.WebSocketsInit.html | 4 +- ...2p_websockets.index.WebSocketsMetrics.html | 4 +- ..._webtransport.WebTransportCertificate.html | 4 +- ...p_webtransport.WebTransportComponents.html | 4 +- ..._libp2p_webtransport.WebTransportInit.html | 4 +- ...bp2p_webtransport.WebTransportMetrics.html | 4 +- interfaces/libp2p.index.Libp2pInit.html | 34 ++++----- modules/_libp2p_crypto.hmac.html | 2 +- modules/_libp2p_crypto.index.html | 2 +- modules/_libp2p_crypto.keys.html | 2 +- .../_libp2p_crypto.keys.keysPBM.KeyType.html | 2 +- ...libp2p_crypto.keys.keysPBM.PrivateKey.html | 2 +- ..._libp2p_crypto.keys.keysPBM.PublicKey.html | 2 +- modules/_libp2p_crypto.keys.keysPBM.html | 2 +- ...interface_compliance_tests.connection.html | 2 +- ...ompliance_tests.connection_encryption.html | 2 +- ...bp2p_interface_compliance_tests.index.html | 2 +- ...erface_compliance_tests.is_valid_tick.html | 2 +- ...p_interface_compliance_tests.matchers.html | 2 +- ...bp2p_interface_compliance_tests.mocks.html | 2 +- ...rface_compliance_tests.peer_discovery.html | 2 +- ...bp2p_interface_compliance_tests.peers.html | 2 +- ...p2p_interface_compliance_tests.pubsub.html | 2 +- ...terface_compliance_tests.stream_muxer.html | 2 +- ..._interface_compliance_tests.transport.html | 2 +- modules/_libp2p_kad_dht.MessageType.html | 2 +- modules/_libp2p_pubsub.errors.html | 2 +- modules/_libp2p_pubsub.index.html | 2 +- modules/_libp2p_pubsub.peer_streams.html | 2 +- modules/_libp2p_pubsub.utils.html | 2 +- modules/_libp2p_utils.abort_options.html | 2 +- modules/_libp2p_utils.abstract_stream.html | 2 +- modules/_libp2p_utils.adaptive_timeout.html | 2 +- modules/_libp2p_utils.address_sort.html | 2 +- modules/_libp2p_utils.array_equals.html | 2 +- modules/_libp2p_utils.close.html | 2 +- modules/_libp2p_utils.close_source.html | 2 +- modules/_libp2p_utils.filters.html | 2 +- modules/_libp2p_utils.index.html | 2 +- .../_libp2p_utils.ip_port_to_multiaddr.html | 2 +- modules/_libp2p_utils.is_promise.html | 2 +- modules/_libp2p_utils.moving_average.html | 2 +- .../_libp2p_utils.multiaddr_is_loopback.html | 2 +- .../_libp2p_utils.multiaddr_is_private.html | 2 +- modules/_libp2p_utils.peer_queue.html | 2 +- modules/_libp2p_utils.priority_queue.html | 2 +- modules/_libp2p_utils.private_ip.html | 2 +- modules/_libp2p_utils.queue.html | 2 +- modules/_libp2p_utils.rate_limiter.html | 2 +- modules/_libp2p_utils.stream_to_ma_conn.html | 2 +- modules/_libp2p_utils.tracked_list.html | 2 +- modules/_libp2p_utils.tracked_map.html | 2 +- modules/_libp2p_websockets.filters.html | 2 +- modules/_libp2p_websockets.index.html | 2 +- modules/libp2p.index.html | 2 +- modules/libp2p.version.html | 2 +- ...p_devtools_metrics.ApplicationMessage.html | 2 +- ...bp2p_devtools_metrics.DevToolsMessage.html | 2 +- ...libp2p_devtools_metrics.WorkerMessage.html | 2 +- types/_libp2p_interface.CalculateMetric.html | 2 +- types/_libp2p_interface.ConnectionStatus.html | 2 +- types/_libp2p_interface.Direction.html | 2 +- types/_libp2p_interface.EventHandler.html | 2 +- ...erface.InboundConnectionUpgradeEvents.html | 2 +- types/_libp2p_interface.KeyType.html | 2 +- types/_libp2p_interface.Libp2pStatus.html | 2 +- types/_libp2p_interface.Message.html | 2 +- ...nterface.OpenConnectionProgressEvents.html | 2 +- ...rface.OutboundConnectionUpgradeEvents.html | 2 +- types/_libp2p_interface.PeerIdType.html | 2 +- .../_libp2p_interface.PendingDialStatus.html | 2 +- types/_libp2p_interface.ReadStatus.html | 2 +- types/_libp2p_interface.ServiceMap.html | 2 +- types/_libp2p_interface.SignaturePolicy.html | 2 +- types/_libp2p_interface.StreamStatus.html | 2 +- ...ce.TransportManagerDialProgressEvents.html | 2 +- types/_libp2p_interface.WriteStatus.html | 2 +- types/_libp2p_kad_dht.DHTProgressEvents.html | 2 +- types/_libp2p_kad_dht.MessageName.html | 2 +- types/_libp2p_kad_dht.QueryEvent.html | 2 +- types/_libp2p_kad_dht.Selectors.html | 2 +- types/_libp2p_kad_dht.Validators.html | 2 +- types/_libp2p_tcp.TCPDialEvents.html | 2 +- types/_libp2p_utils.queue.JobStatus.html | 2 +- ...websockets.index.WebSocketsDialEvents.html | 2 +- ...p_webtransport.WebTransportDialEvents.html | 2 +- types/libp2p.index.Libp2pOptions.html | 2 +- types/libp2p.index.ServiceFactoryMap.html | 2 +- ...p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html | 2 +- ..._circuit_relay_v2.RELAY_V2_STOP_CODEC.html | 2 +- .../_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html | 2 +- .../_libp2p_crypto.keys.supportedKeys.html | 2 +- variables/_libp2p_dcutr.multicodec.html | 2 +- ...s_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html | 2 +- ...evtools_metrics.SOURCE_CONTENT_SCRIPT.html | 2 +- ...bp2p_devtools_metrics.SOURCE_DEVTOOLS.html | 2 +- ...ibp2p_devtools_metrics.SOURCE_METRICS.html | 2 +- ...evtools_metrics.SOURCE_SERVICE_WORKER.html | 2 +- .../_libp2p_devtools_metrics.valueCodecs.html | 2 +- variables/_libp2p_floodsub.multicodec.html | 2 +- variables/_libp2p_interface.CustomEvent.html | 2 +- ..._libp2p_interface.ERR_INVALID_MESSAGE.html | 2 +- ...bp2p_interface.ERR_INVALID_PARAMETERS.html | 2 +- .../_libp2p_interface.ERR_NOT_FOUND.html | 2 +- variables/_libp2p_interface.ERR_TIMEOUT.html | 2 +- variables/_libp2p_interface.Ed25519.html | 2 +- variables/_libp2p_interface.KEEP_ALIVE.html | 2 +- variables/_libp2p_interface.RSA.html | 2 +- variables/_libp2p_interface.StrictNoSign.html | 2 +- variables/_libp2p_interface.StrictSign.html | 2 +- .../_libp2p_interface.connectionSymbol.html | 2 +- ...libp2p_interface.contentRoutingSymbol.html | 2 +- ..._libp2p_interface.peerDiscoverySymbol.html | 2 +- variables/_libp2p_interface.peerIdSymbol.html | 2 +- .../_libp2p_interface.peerRoutingSymbol.html | 2 +- variables/_libp2p_interface.secp256k1.html | 2 +- ..._libp2p_interface.serviceCapabilities.html | 2 +- ..._libp2p_interface.serviceDependencies.html | 2 +- .../_libp2p_interface.transportSymbol.html | 2 +- ...ce_compliance_tests.mocks.mockNetwork.html | 2 +- ...erface_compliance_tests.peers.default.html | 2 +- ...libp2p_multistream_select.PROTOCOL_ID.html | 2 +- variables/_libp2p_ping.PING_PROTOCOL.html | 2 +- variables/_libp2p_pubsub.errors.codes.html | 2 +- variables/_libp2p_tls.PROTOCOL.html | 2 +- ...ve_timeout.DEFAULT_FAILURE_MULTIPLIER.html | 2 +- ....adaptive_timeout.DEFAULT_MIN_TIMEOUT.html | 2 +- ...ve_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html | 2 +- ...p2p_utils.ip_port_to_multiaddr.Errors.html | 2 +- variables/libp2p.version.name.html | 2 +- variables/libp2p.version.version.html | 2 +- 566 files changed, 1405 insertions(+), 1405 deletions(-) diff --git a/classes/_libp2p_crypto.keys.Ed25519PrivateKey.html b/classes/_libp2p_crypto.keys.Ed25519PrivateKey.html index 333d662fa2..d554196f2f 100644 --- a/classes/_libp2p_crypto.keys.Ed25519PrivateKey.html +++ b/classes/_libp2p_crypto.keys.Ed25519PrivateKey.html @@ -1,5 +1,5 @@ Ed25519PrivateKey | libp2p

Class Ed25519PrivateKey

Generic private key interface

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_key _publicKey

Accessors

bytes @@ -10,9 +10,9 @@ id marshal sign -

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Private Readonly _publicKey

_publicKey: Uint8Array

Accessors

bytes

public

Methods

equals

export

hash

id

  • id(): Promise<string>

  • Gets the ID of the key.

    +

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Private Readonly _publicKey

_publicKey: Uint8Array

Accessors

bytes

public

Methods

equals

export

hash

id

  • id(): Promise<string>

  • Gets the ID of the key.

    The key id is the base58 encoding of the identity multihash containing its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

    -

    Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexporthashidmarshalsign
\ No newline at end of file +

Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexporthashidmarshalsign
\ No newline at end of file diff --git a/classes/_libp2p_crypto.keys.Ed25519PublicKey.html b/classes/_libp2p_crypto.keys.Ed25519PublicKey.html index 9eb1c6f44d..0eba1e43e7 100644 --- a/classes/_libp2p_crypto.keys.Ed25519PublicKey.html +++ b/classes/_libp2p_crypto.keys.Ed25519PublicKey.html @@ -1,8 +1,8 @@ -Ed25519PublicKey | libp2p

Class Ed25519PublicKey

Implements

Constructors

constructor +Ed25519PublicKey | libp2p

Class Ed25519PublicKey

Implements

Constructors

constructor

Properties

_key

Accessors

bytes

Methods

equals hash marshal verify -

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file diff --git a/classes/_libp2p_crypto.keys.RsaPrivateKey.html b/classes/_libp2p_crypto.keys.RsaPrivateKey.html index 5681f6f302..f362ee3391 100644 --- a/classes/_libp2p_crypto.keys.RsaPrivateKey.html +++ b/classes/_libp2p_crypto.keys.RsaPrivateKey.html @@ -1,5 +1,5 @@ RsaPrivateKey | libp2p

Class RsaPrivateKey

Generic private key interface

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_key _publicKey

Accessors

bytes @@ -11,12 +11,12 @@ id marshal sign -

Constructors

constructor

Properties

Private Readonly _key

_key: JsonWebKey

Private Readonly _publicKey

_publicKey: JsonWebKey

Accessors

bytes

public

Methods

equals

export

  • export(password, format?): Promise<Multibase<"m">>

  • Exports the key as libp2p-key - a aes-gcm encrypted value with the key +

Constructors

constructor

Properties

Private Readonly _key

_key: JsonWebKey

Private Readonly _publicKey

_publicKey: JsonWebKey

Accessors

bytes

public

Methods

equals

export

  • export(password, format?): Promise<Multibase<"m">>

  • Exports the key as libp2p-key - a aes-gcm encrypted value with the key derived from the password.

    To export it as a password protected PEM file, please use the exportPEM function from @libp2p/rsa.

    -

    Parameters

    • password: string
    • format: string = 'pkcs-8'

    Returns Promise<Multibase<"m">>

genSecret

hash

id

genSecret

hash

id

  • id(): Promise<string>

  • Gets the ID of the key.

    The key id is the base58 encoding of the SHA-256 multihash of its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

    -

    Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexportgenSecrethashidmarshalsign
\ No newline at end of file +

Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexportgenSecrethashidmarshalsign
\ No newline at end of file diff --git a/classes/_libp2p_crypto.keys.RsaPublicKey.html b/classes/_libp2p_crypto.keys.RsaPublicKey.html index f78f95466b..16b7e4f42f 100644 --- a/classes/_libp2p_crypto.keys.RsaPublicKey.html +++ b/classes/_libp2p_crypto.keys.RsaPublicKey.html @@ -1,8 +1,8 @@ -RsaPublicKey | libp2p

Class RsaPublicKey

Implements

Constructors

constructor +RsaPublicKey | libp2p

Class RsaPublicKey

Implements

Constructors

constructor

Properties

_key

Accessors

bytes

Methods

equals hash marshal verify -

Constructors

constructor

Properties

Private Readonly _key

_key: JsonWebKey

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly _key

_key: JsonWebKey

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file diff --git a/classes/_libp2p_crypto.keys.Secp256k1PrivateKey.html b/classes/_libp2p_crypto.keys.Secp256k1PrivateKey.html index eb4f28f8b9..cffb8fd2a8 100644 --- a/classes/_libp2p_crypto.keys.Secp256k1PrivateKey.html +++ b/classes/_libp2p_crypto.keys.Secp256k1PrivateKey.html @@ -1,5 +1,5 @@ Secp256k1PrivateKey | libp2p

Class Secp256k1PrivateKey

Generic private key interface

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_key _publicKey

Accessors

bytes @@ -10,9 +10,9 @@ id marshal sign -

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Private Readonly _publicKey

_publicKey: Uint8Array

Accessors

bytes

public

Methods

equals

export

hash

id

  • id(): Promise<string>

  • Gets the ID of the key.

    +

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Private Readonly _publicKey

_publicKey: Uint8Array

Accessors

bytes

public

Methods

equals

export

hash

id

  • id(): Promise<string>

  • Gets the ID of the key.

    The key id is the base58 encoding of the SHA-256 multihash of its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

    -

    Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexporthashidmarshalsign
\ No newline at end of file +

Returns Promise<string>

marshal

sign

Settings

Member Visibility

Theme

On This Page

constructor_key_publicKeybytespublicequalsexporthashidmarshalsign
\ No newline at end of file diff --git a/classes/_libp2p_crypto.keys.Secp256k1PublicKey.html b/classes/_libp2p_crypto.keys.Secp256k1PublicKey.html index ac6a6771e3..5a3adbf92a 100644 --- a/classes/_libp2p_crypto.keys.Secp256k1PublicKey.html +++ b/classes/_libp2p_crypto.keys.Secp256k1PublicKey.html @@ -1,8 +1,8 @@ -Secp256k1PublicKey | libp2p

Class Secp256k1PublicKey

Implements

Constructors

constructor +Secp256k1PublicKey | libp2p

Class Secp256k1PublicKey

Implements

Constructors

constructor

Properties

_key

Accessors

bytes

Methods

equals hash marshal verify -

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly _key

_key: Uint8Array

Accessors

bytes

Methods

equals

hash

marshal

verify

Settings

Member Visibility

Theme

On This Page

constructor_keybytesequalshashmarshalverify
\ No newline at end of file diff --git a/classes/_libp2p_floodsub.FloodSub.html b/classes/_libp2p_floodsub.FloodSub.html index 7622ff8ae1..1bc70983a9 100644 --- a/classes/_libp2p_floodsub.FloodSub.html +++ b/classes/_libp2p_floodsub.FloodSub.html @@ -1,7 +1,7 @@ FloodSub | libp2p

Class FloodSub

FloodSub (aka dumbsub is an implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

#private [serviceDependencies] [toStringTag] @@ -53,12 +53,12 @@ subscribe unsubscribe validate -

Constructors

constructor

Properties

Private #private

#private: any

Readonly [serviceDependencies]

[serviceDependencies]: string[] = ...

Readonly [toStringTag]

[toStringTag]: "@libp2p/floodsub" = '@libp2p/floodsub'

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

+

Constructors

constructor

Properties

Private #private

#private: any

Readonly [serviceDependencies]

[serviceDependencies]: string[] = ...

Readonly [toStringTag]

[toStringTag]: "@libp2p/floodsub" = '@libp2p/floodsub'

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

Protected enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

Protected log

log: Logger

multicodecs

multicodecs: string[]

A list of multicodecs that contain the pubsub protocol name.

peers

peers: PeerMap<PeerStreams>

Map of peer streams

-

queue

queue: default<default, QueueAddOptions>

seenCache

seenCache: SimpleTimeCache<boolean>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

+

queue

queue: default<default, QueueAddOptions>

seenCache

seenCache: SimpleTimeCache<boolean>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

Keyed by topic Topic validators are functions with the following input:

@@ -72,24 +72,24 @@

Parameters

Returns boolean

addEventListener

addPeer

buildMessage

  • buildMessage(message): Promise<Message>

  • Normalizes the message and signs it, if signing is enabled. Should be used by the routers to create the message to send.

    -

    Parameters

    • message: {
          data: Uint8Array;
          from: PeerId;
          sequenceNumber: bigint;
          topic: string;
      }

    Returns Promise<Message>

decodeMessage

decodeRpc

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

    Parameters

    • message: {
          data: Uint8Array;
          from: PeerId;
          sequenceNumber: bigint;
          topic: string;
      }

    Returns Promise<Message>

decodeMessage

decodeRpc

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

encodeMessage

encodeRpc

getMsgId

encodeRpc

getMsgId

getPeers

getSubscribers

  • getSubscribers(topic): PeerId[]

  • Get a list of the peer-ids that are subscribed to one topic.

    Parameters

    • topic: string

    Returns PeerId[]

getTopics

  • getTopics(): string[]

  • Get the list of topics which the peer is subscribed to.

    Returns string[]

isStarted

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

processMessage

processMessages

processMessages

processRpc

processRpcSubOpt

publish

publishMessage

removeEventListener

safeDispatchEvent

send

removeEventListener

safeDispatchEvent

send

  • send(peer, data): void

  • Send an rpc object to a peer

    Parameters

    • peer: PeerId
    • data: {
          messages?: Message[];
          subscribe?: boolean;
          subscriptions?: string[];
      }
      • Optional messages?: Message[]
      • Optional subscribe?: boolean
      • Optional subscriptions?: string[]

    Returns void

sendRpc

start

stop

  • stop(): Promise<void>

  • Unregister the pubsub protocol and the streams with other peers will be closed.

    diff --git a/classes/_libp2p_interface.AbortError.html b/classes/_libp2p_interface.AbortError.html index 3dcfc7a14b..7d54b7e4c2 100644 --- a/classes/_libp2p_interface.AbortError.html +++ b/classes/_libp2p_interface.AbortError.html @@ -1,7 +1,7 @@ AbortError | libp2p

    Class AbortError

    When this error is thrown it means an operation was aborted, usually in response to the abort event being emitted by an AbortSignal.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    cause? code message @@ -13,7 +13,7 @@ stackTraceLimit type

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Readonly type

    type: string

    Static Readonly code

    code: "ABORT_ERR" = 'ABORT_ERR'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Readonly type

    type: string

    Static Readonly code

    code: "ABORT_ERR" = 'ABORT_ERR'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -

    Static stackTraceLimit

    stackTraceLimit: number

    Static Readonly type

    type: "aborted" = 'aborted'

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Static Readonly type

    type: "aborted" = 'aborted'

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodemessagenamestacktypecodeprepareStackTracestackTraceLimittypecaptureStackTrace
    \ No newline at end of file diff --git a/classes/_libp2p_interface.AggregateCodeError.html b/classes/_libp2p_interface.AggregateCodeError.html index 33fd66ae48..eba2590dcd 100644 --- a/classes/_libp2p_interface.AggregateCodeError.html +++ b/classes/_libp2p_interface.AggregateCodeError.html @@ -1,4 +1,4 @@ -AggregateCodeError | libp2p

    Class AggregateCodeError<T>

    Type Parameters

    Hierarchy

    Constructors

    constructor +AggregateCodeError | libp2p

    Class AggregateCodeError<T>

    Type Parameters

    Hierarchy

    Constructors

    constructor

    Properties

    cause? code errors @@ -6,4 +6,4 @@ name props stack? -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    errors

    errors: any[]

    message

    message: string

    name

    name: string

    Readonly props

    props: T

    Optional stack

    stack?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodeerrorsmessagenamepropsstack
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    errors

    errors: any[]

    message

    message: string

    name

    name: string

    Readonly props

    props: T

    Optional stack

    stack?: string

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodeerrorsmessagenamepropsstack
    \ No newline at end of file diff --git a/classes/_libp2p_interface.CodeError.html b/classes/_libp2p_interface.CodeError.html index 6830778495..bc2e72d592 100644 --- a/classes/_libp2p_interface.CodeError.html +++ b/classes/_libp2p_interface.CodeError.html @@ -1,4 +1,4 @@ -CodeError | libp2p

    Class CodeError<T>

    Type Parameters

    Hierarchy

    Constructors

    constructor +CodeError | libp2p

    Class CodeError<T>

    Type Parameters

    Hierarchy

    Constructors

    constructor

    Properties

    cause? code message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    message

    message: string

    name

    name: string

    Readonly props

    props: T

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    Readonly code

    code: string

    message

    message: string

    name

    name: string

    Readonly props

    props: T

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodemessagenamepropsstackprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidCryptoExchangeError.html b/classes/_libp2p_interface.InvalidCryptoExchangeError.html index 643b8ea428..aa4557d891 100644 --- a/classes/_libp2p_interface.InvalidCryptoExchangeError.html +++ b/classes/_libp2p_interface.InvalidCryptoExchangeError.html @@ -1,4 +1,4 @@ -InvalidCryptoExchangeError | libp2p

    Class InvalidCryptoExchangeError

    Hierarchy

    • Error
      • InvalidCryptoExchangeError

    Constructors

    constructor +InvalidCryptoExchangeError | libp2p

    Class InvalidCryptoExchangeError

    Hierarchy

    • Error
      • InvalidCryptoExchangeError

    Constructors

    constructor

    Properties

    cause? code message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Readonly code

    code: "ERR_INVALID_CRYPTO_EXCHANGE" = 'ERR_INVALID_CRYPTO_EXCHANGE'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Readonly code

    code: "ERR_INVALID_CRYPTO_EXCHANGE" = 'ERR_INVALID_CRYPTO_EXCHANGE'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodemessagenamestackcodeprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/classes/_libp2p_interface.InvalidCryptoTransmissionError.html b/classes/_libp2p_interface.InvalidCryptoTransmissionError.html index 4658681fed..0cb21afa26 100644 --- a/classes/_libp2p_interface.InvalidCryptoTransmissionError.html +++ b/classes/_libp2p_interface.InvalidCryptoTransmissionError.html @@ -1,4 +1,4 @@ -InvalidCryptoTransmissionError | libp2p

    Class InvalidCryptoTransmissionError

    Hierarchy

    • Error
      • InvalidCryptoTransmissionError

    Constructors

    constructor +InvalidCryptoTransmissionError | libp2p

    Class InvalidCryptoTransmissionError

    Hierarchy

    • Error
      • InvalidCryptoTransmissionError

    Constructors

    constructor

    Properties

    cause? code message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Readonly code

    code: "ERR_INVALID_CRYPTO_TRANSMISSION" = 'ERR_INVALID_CRYPTO_TRANSMISSION'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: unknown

    code

    code: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Readonly code

    code: "ERR_INVALID_CRYPTO_TRANSMISSION" = 'ERR_INVALID_CRYPTO_TRANSMISSION'

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any

      • Parameters

        Returns any

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcausecodemessagenamestackcodeprepareStackTracestackTraceLimitcaptureStackTrace
    \ No newline at end of file diff --git a/classes/_libp2p_interface.TypedEventEmitter.html b/classes/_libp2p_interface.TypedEventEmitter.html index 23a006db34..26ccb9c986 100644 --- a/classes/_libp2p_interface.TypedEventEmitter.html +++ b/classes/_libp2p_interface.TypedEventEmitter.html @@ -1,12 +1,12 @@ TypedEventEmitter | libp2p

    Class TypedEventEmitter<EventMap>

    An implementation of a typed event target etc

    -

    Type Parameters

    • EventMap extends Record<string, any>

    Hierarchy

    Implements

    Constructors

    constructor +

    Type Parameters

    • EventMap extends Record<string, any>

    Hierarchy

    Implements

    Constructors

    constructor

    Properties

    #listeners

    Methods

    addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

    Constructors

    constructor

    Properties

    Private Readonly #listeners

    #listeners: Map<any, Listener[]> = ...

    Methods

    addEventListener

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private Readonly #listeners

    #listeners: Map<any, Listener[]> = ...

    Methods

    addEventListener

    dispatchEvent

    listenerCount

    removeEventListener

    safeDispatchEvent

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#listenersaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
    \ No newline at end of file +

    Parameters

    Returns boolean

listenerCount

removeEventListener

safeDispatchEvent

Settings

Member Visibility

Theme

On This Page

constructor#listenersaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
\ No newline at end of file diff --git a/classes/_libp2p_interface.UnexpectedPeerError.html b/classes/_libp2p_interface.UnexpectedPeerError.html index 00471e8417..6b41a20618 100644 --- a/classes/_libp2p_interface.UnexpectedPeerError.html +++ b/classes/_libp2p_interface.UnexpectedPeerError.html @@ -1,4 +1,4 @@ -UnexpectedPeerError | libp2p

Class UnexpectedPeerError

Hierarchy

Constructors

constructor +UnexpectedPeerError | libp2p

Class UnexpectedPeerError

Hierarchy

Constructors

constructor

Properties

cause? code message @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Readonly code

code: "ERR_UNEXPECTED_PEER" = 'ERR_UNEXPECTED_PEER'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Readonly code

code: "ERR_UNEXPECTED_PEER" = 'ERR_UNEXPECTED_PEER'

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackcodeprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerFilter.html b/classes/_libp2p_peer_collections.PeerFilter.html index 1291a1f05e..d2e2f05ff3 100644 --- a/classes/_libp2p_peer_collections.PeerFilter.html +++ b/classes/_libp2p_peer_collections.PeerFilter.html @@ -1,8 +1,8 @@ PeerFilter | libp2p

Class PeerFilter

Uses a Cuckoo filter to implement a mechanism for deduplicating PeerIds in a way that uses a smaller amount of memory than a PeerSet.

-

Constructors

constructor +

Constructors

constructor

Properties

filter

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly filter

filter: Filter

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorfilteraddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly filter

filter: Filter

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorfilteraddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerList.html b/classes/_libp2p_peer_collections.PeerList.html index 3bbe933f7c..bc04d25713 100644 --- a/classes/_libp2p_peer_collections.PeerList.html +++ b/classes/_libp2p_peer_collections.PeerList.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerList } from '@libp2p/peer-collections'

const list = peerList()
list.push(peerId)
-

Constructors

constructor +

Constructors

constructor

Properties

list

Accessors

length

Methods

[iterator] @@ -23,4 +23,4 @@ push shift unshift -

Constructors

constructor

Properties

Private list

list: string[]

Accessors

length

  • get length(): number

  • Returns number

Methods

[iterator]

clear

concat

entries

every

  • every(predicate): boolean

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns boolean

filter

  • filter(predicate): PeerList

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns PeerList

find

  • find(predicate): undefined | PeerId

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns undefined | PeerId

findIndex

  • findIndex(predicate): number

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns number

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, arr) => void)
        • (peerId, index, arr): void

        • Parameters

          Returns void

    Returns void

includes

  • includes(peerId): boolean

  • Parameters

    Returns boolean

indexOf

pop

push

  • push(...peerIds): void

  • Parameters

    Returns void

shift

unshift

  • unshift(...peerIds): number

  • Parameters

    Returns number

Settings

Member Visibility

Theme

On This Page

constructorlistlength[iterator]clearconcatentrieseveryfilterfindfindIndexforEachincludesindexOfpoppushshiftunshift
\ No newline at end of file +

Constructors

constructor

Properties

Private list

list: string[]

Accessors

length

  • get length(): number

  • Returns number

Methods

[iterator]

clear

concat

entries

every

  • every(predicate): boolean

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns boolean

filter

  • filter(predicate): PeerList

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns PeerList

find

  • find(predicate): undefined | PeerId

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns undefined | PeerId

findIndex

  • findIndex(predicate): number

  • Parameters

    • predicate: ((peerId, index, arr) => boolean)
        • (peerId, index, arr): boolean

        • Parameters

          Returns boolean

    Returns number

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, arr) => void)
        • (peerId, index, arr): void

        • Parameters

          Returns void

    Returns void

includes

  • includes(peerId): boolean

  • Parameters

    Returns boolean

indexOf

pop

push

  • push(...peerIds): void

  • Parameters

    Returns void

shift

unshift

  • unshift(...peerIds): number

  • Parameters

    Returns number

Settings

Member Visibility

Theme

On This Page

constructorlistlength[iterator]clearconcatentrieseveryfilterfindfindIndexforEachincludesindexOfpoppushshiftunshift
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerMap.html b/classes/_libp2p_peer_collections.PeerMap.html index d0af4fceb5..3eb07356e2 100644 --- a/classes/_libp2p_peer_collections.PeerMap.html +++ b/classes/_libp2p_peer_collections.PeerMap.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerMap } from '@libp2p/peer-collections'

const map = peerMap<string>()
map.set(peerId, 'value')
-

Type Parameters

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Properties

map

Accessors

size

Methods

[iterator] @@ -18,4 +18,4 @@ keys set values -

Constructors

constructor

Properties

Private Readonly map

map: Map<string, T>

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

clear

  • clear(): void

  • Returns void

delete

  • delete(peer): boolean

  • Parameters

    Returns boolean

entries

forEach

  • forEach(fn): void

  • Parameters

    • fn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          Returns void

    Returns void

get

  • get(peer): undefined | T

  • Parameters

    Returns undefined | T

has

  • has(peer): boolean

  • Parameters

    Returns boolean

keys

set

  • set(peer, value): void

  • Parameters

    Returns void

values

  • values(): IterableIterator<T>

  • Returns IterableIterator<T>

Settings

Member Visibility

Theme

On This Page

constructormapsize[iterator]cleardeleteentriesforEachgethaskeyssetvalues
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly map

map: Map<string, T>

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

clear

  • clear(): void

  • Returns void

delete

  • delete(peer): boolean

  • Parameters

    Returns boolean

entries

forEach

  • forEach(fn): void

  • Parameters

    • fn: ((value, key, map) => void)
        • (value, key, map): void

        • Parameters

          Returns void

    Returns void

get

  • get(peer): undefined | T

  • Parameters

    Returns undefined | T

has

  • has(peer): boolean

  • Parameters

    Returns boolean

keys

set

  • set(peer, value): void

  • Parameters

    Returns void

values

  • values(): IterableIterator<T>

  • Returns IterableIterator<T>

Settings

Member Visibility

Theme

On This Page

constructormapsize[iterator]cleardeleteentriesforEachgethaskeyssetvalues
\ No newline at end of file diff --git a/classes/_libp2p_peer_collections.PeerSet.html b/classes/_libp2p_peer_collections.PeerSet.html index 8e2245e14d..ce0c94a20c 100644 --- a/classes/_libp2p_peer_collections.PeerSet.html +++ b/classes/_libp2p_peer_collections.PeerSet.html @@ -5,7 +5,7 @@ should be a cheap operation.

Example

import { peerSet } from '@libp2p/peer-collections'

const set = peerSet()
set.add(peerId)
-

Constructors

constructor +

Constructors

constructor

Properties

set

Accessors

size

Methods

[iterator] @@ -19,4 +19,4 @@ intersection union values -

Constructors

constructor

Properties

Private Readonly set

set: Set<string>

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

add

clear

  • clear(): void

  • Returns void

delete

difference

entries

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, set) => void)

    Returns void

has

  • has(peer): boolean

  • Parameters

    Returns boolean

intersection

union

values

Settings

Member Visibility

Theme

On This Page

constructorsetsize[iterator]addcleardeletedifferenceentriesforEachhasintersectionunionvalues
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly set

set: Set<string>

Accessors

size

  • get size(): number

  • Returns number

Methods

[iterator]

add

clear

  • clear(): void

  • Returns void

delete

difference

entries

forEach

  • forEach(predicate): void

  • Parameters

    • predicate: ((peerId, index, set) => void)

    Returns void

has

  • has(peer): boolean

  • Parameters

    Returns boolean

intersection

union

values

Settings

Member Visibility

Theme

On This Page

constructorsetsize[iterator]addcleardeletedifferenceentriesforEachhasintersectionunionvalues
\ No newline at end of file diff --git a/classes/_libp2p_peer_record.PeerRecord.html b/classes/_libp2p_peer_record.PeerRecord.html index 5b8ec13af7..2dc3688e7c 100644 --- a/classes/_libp2p_peer_record.PeerRecord.html +++ b/classes/_libp2p_peer_record.PeerRecord.html @@ -1,6 +1,6 @@ PeerRecord | libp2p

Class PeerRecord

The PeerRecord is used for distributing peer routing records across the network. It contains the peer's reachable listen addresses.

-

Constructors

constructor +

Constructors

constructor

Properties

codec domain marshaled? @@ -12,7 +12,7 @@

Methods

equals marshal createFromProtobuf -

Constructors

constructor

Properties

codec

codec: Uint8Array = PeerRecord.CODEC

domain

domain: string = PeerRecord.DOMAIN

Private Optional marshaled

marshaled?: Uint8Array

multiaddrs

multiaddrs: Multiaddr[]

peerId

peerId: PeerId

seqNumber

seqNumber: bigint

Static CODEC

CODEC: Uint8Array = ENVELOPE_PAYLOAD_TYPE_PEER_RECORD

Static DOMAIN

DOMAIN: string = ENVELOPE_DOMAIN_PEER_RECORD

Methods

equals

  • equals(other): boolean

  • Returns true if this record equals the other

    -

    Parameters

    • other: unknown

    Returns boolean

marshal

Static createFromProtobuf

Settings

Member Visibility

Theme

On This Page

constructorcodecdomainmarshaledmultiaddrspeerIdseqNumberCODECDOMAINequalsmarshalcreateFromProtobuf
\ No newline at end of file +

Constructors

constructor

Properties

codec

codec: Uint8Array = PeerRecord.CODEC

domain

domain: string = PeerRecord.DOMAIN

Private Optional marshaled

marshaled?: Uint8Array

multiaddrs

multiaddrs: Multiaddr[]

peerId

peerId: PeerId

seqNumber

seqNumber: bigint

Static CODEC

CODEC: Uint8Array = ENVELOPE_PAYLOAD_TYPE_PEER_RECORD

Static DOMAIN

DOMAIN: string = ENVELOPE_DOMAIN_PEER_RECORD

Methods

equals

  • equals(other): boolean

  • Returns true if this record equals the other

    +

    Parameters

    • other: unknown

    Returns boolean

marshal

Static createFromProtobuf

Settings

Member Visibility

Theme

On This Page

constructorcodecdomainmarshaledmultiaddrspeerIdseqNumberCODECDOMAINequalsmarshalcreateFromProtobuf
\ No newline at end of file diff --git a/classes/_libp2p_peer_record.RecordEnvelope.html b/classes/_libp2p_peer_record.RecordEnvelope.html index 1def5a0755..21478ce487 100644 --- a/classes/_libp2p_peer_record.RecordEnvelope.html +++ b/classes/_libp2p_peer_record.RecordEnvelope.html @@ -1,4 +1,4 @@ -RecordEnvelope | libp2p

Class RecordEnvelope

Implements

Constructors

constructor +RecordEnvelope | libp2p

Class RecordEnvelope

Implements

Constructors

constructor

Properties

marshaled? payload payloadType @@ -12,12 +12,12 @@ seal

Constructors

constructor

Properties

Optional marshaled

marshaled?: Uint8Array

payload

payload: Uint8Array

payloadType

payloadType: Uint8Array

peerId

peerId: PeerId

signature

signature: Uint8Array

Methods

equals

marshal

validate

Static createFromProtobuf

Static openAndCertify

Properties

Optional marshaled

marshaled?: Uint8Array

payload

payload: Uint8Array

payloadType

payloadType: Uint8Array

peerId

peerId: PeerId

signature

signature: Uint8Array

Methods

equals

marshal

validate

Static createFromProtobuf

Static openAndCertify

Static seal

Static seal

Settings

Member Visibility

Theme

On This Page

constructormarshaledpayloadpayloadTypepeerIdsignatureequalsmarshalvalidatecreateFromProtobufopenAndCertifyseal
\ No newline at end of file +

Parameters

Returns Promise<RecordEnvelope>

Settings

Member Visibility

Theme

On This Page

constructormarshaledpayloadpayloadTypepeerIdsignatureequalsmarshalvalidatecreateFromProtobufopenAndCertifyseal
\ No newline at end of file diff --git a/classes/_libp2p_peer_store.PersistentPeerStore.html b/classes/_libp2p_peer_store.PersistentPeerStore.html index 2255370a42..5e4e295b19 100644 --- a/classes/_libp2p_peer_store.PersistentPeerStore.html +++ b/classes/_libp2p_peer_store.PersistentPeerStore.html @@ -1,5 +1,5 @@ PersistentPeerStore | libp2p

Class PersistentPeerStore

An implementation of PeerStore that stores data in a Datastore

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

[toStringTag] events log @@ -15,38 +15,38 @@ merge patch save -

Constructors

constructor

Properties

Readonly [toStringTag]

[toStringTag]: "@libp2p/peer-store" = '@libp2p/peer-store'

Private Readonly events

events: TypedEventTarget<Libp2pEvents<ServiceMap>>

Private Readonly log

log: Logger

Private Readonly peerId

peerId: PeerId

Private Readonly store

store: PersistentStore

Methods

Private #emitIfUpdated

all

  • all(query?): Promise<Peer[]>

  • Returns all peers in the peer store.

    +

Constructors

constructor

Properties

Readonly [toStringTag]

[toStringTag]: "@libp2p/peer-store" = '@libp2p/peer-store'

Private Readonly events

events: TypedEventTarget<Libp2pEvents<ServiceMap>>

Private Readonly log

log: Logger

Private Readonly peerId

peerId: PeerId

Private Readonly store

store: PersistentStore

Methods

Private #emitIfUpdated

all

consumePeerRecord

  • consumePeerRecord(buf, expectedPeer?): Promise<boolean>

  • Unmarshal and verify a signed peer record, extract the multiaddrs and +

consumePeerRecord

  • consumePeerRecord(buf, expectedPeer?): Promise<boolean>

  • Unmarshal and verify a signed peer record, extract the multiaddrs and overwrite the stored addresses for the peer.

    Optionally pass an expected PeerId to verify that the peer record was signed by that peer.

    Parameters

    Returns Promise<boolean>

    Example

    await peerStore.consumePeerRecord(buf, expectedPeer)
    -

delete

delete

  • delete(peerId): Promise<void>

  • Delete all data stored for the passed peer

    Parameters

    Returns Promise<void>

    Example

    await peerStore.addressBook.set(peerId, multiaddrs)
    await peerStore.addressBook.get(peerId)
    // multiaddrs[]

    await peerStore.delete(peerId)

    await peerStore.addressBook.get(peerId)
    // []
    -

forEach

forEach

  • forEach(fn, query?): Promise<void>

  • Loop over every peer - the looping is async because we read from a datastore but the peer operation is sync, this is to prevent long-lived peer operations causing deadlocks over the datastore which can happen if they try to access the peer store during the loop

    Parameters

    • fn: ((peer) => void)
        • (peer): void

        • Parameters

          Returns void

    • Optional query: PeerQuery

    Returns Promise<void>

    Example

    await peerStore.forEach(peer => {
      // ...
    })
    -

get

get

has

has

  • has(peerId): Promise<boolean>

  • Returns true if the passed PeerId is in the peer store

    Parameters

    Returns Promise<boolean>

    Example

    await peerStore.has(peerId)
    // false
    await peerStore.addressBook.add(peerId, multiaddrs)
    await peerStore.has(peerId)
    // true
    -

merge

merge

patch

patch

save

save

Settings

Member Visibility

Theme

On This Page

constructor[toStringTag]eventslogpeerIdstore#emitIfUpdatedallconsumePeerRecorddeleteforEachgethasmergepatchsave
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor[toStringTag]eventslogpeerIdstore#emitIfUpdatedallconsumePeerRecorddeleteforEachgethasmergepatchsave
\ No newline at end of file diff --git a/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html b/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html index 399f9c048b..7eba7ce36c 100644 --- a/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html +++ b/classes/_libp2p_pubsub.index.PubSubBaseProtocol.html @@ -1,6 +1,6 @@ PubSubBaseProtocol | libp2p

Class PubSubBaseProtocol<Events>Abstract

PubSubBaseProtocol handles the peers and connections logic for pubsub routers and specifies the API that pubsub routers should have.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

#private _registrarTopologyIds canRelayMessage @@ -51,52 +51,52 @@ subscribe unsubscribe validate -

Constructors

constructor

Properties

Private #private

#private: any

Private _registrarTopologyIds

_registrarTopologyIds: undefined | string[]

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

-

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

-

Protected enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

-

Protected log

log: Logger

Private Readonly maxInboundStreams

maxInboundStreams: number

Private Readonly maxOutboundStreams

maxOutboundStreams: number

multicodecs

multicodecs: string[]

A list of multicodecs that contain the pubsub protocol name.

-

peers

peers: PeerMap<PeerStreams>

Map of peer streams

-

queue

queue: default<default, QueueAddOptions>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

-

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

+

Constructors

constructor

Properties

Private #private

#private: any

Private _registrarTopologyIds

_registrarTopologyIds: undefined | string[]

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

+

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

+

Protected enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

+

Protected log

log: Logger

Private Readonly maxInboundStreams

maxInboundStreams: number

Private Readonly maxOutboundStreams

maxOutboundStreams: number

multicodecs

multicodecs: string[]

A list of multicodecs that contain the pubsub protocol name.

+

peers

peers: PeerMap<PeerStreams>

Map of peer streams

+

queue

queue: default<default, QueueAddOptions>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

+

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

Keyed by topic Topic validators are functions with the following input:

-

topics

topics: Map<string, PeerSet>

Map of topics to which peers are subscribed to

-

Methods

Protected _onIncomingStream

Protected _onPeerConnected

Protected _onPeerDisconnected

  • _onPeerDisconnected(peerId, conn?): void

  • Registrar notifies a closing connection with pubsub protocol

    -

    Parameters

    Returns void

Protected _removePeer

acceptFrom

topics

topics: Map<string, PeerSet>

Map of topics to which peers are subscribed to

+

Methods

Protected _onIncomingStream

Protected _onPeerConnected

Protected _onPeerDisconnected

  • _onPeerDisconnected(peerId, conn?): void

  • Registrar notifies a closing connection with pubsub protocol

    +

    Parameters

    Returns void

Protected _removePeer

acceptFrom

  • acceptFrom(id): boolean

  • Whether to accept a message from a peer Override to create a graylist

    -

    Parameters

    Returns boolean

addEventListener

addPeer

buildMessage

addEventListener

addPeer

buildMessage

Abstract decodeRpc

Abstract decodeRpc

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

    Parameters

    Returns PubSubRPC

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

Abstract encodeMessage

Abstract encodeRpc

Abstract encodeRpc

getMsgId

getMsgId

getPeers

getSubscribers

getTopics

isStarted

listenerCount

processMessage

processMessages

processRpc

processRpcSubOpt

publish

Abstract publishMessage

getPeers

getSubscribers

getTopics

isStarted

listenerCount

processMessage

processMessages

processRpc

processRpcSubOpt

publish

Abstract publishMessage

  • publishMessage(sender, message): Promise<PublishResult>

  • Overriding the implementation of publish should handle the appropriate algorithms for the publish/subscriber implementation. For example, a Floodsub implementation might simply publish each message to each topic for every peer.

    sender might be this peer, or we might be forwarding a message on behalf of another peer, in which case sender is the peer we received the message from, which may not be the peer the message was created by.

    -

    Parameters

    Returns Promise<PublishResult>

removeEventListener

safeDispatchEvent

send

  • send(peer, data): void

  • Send an rpc object to a peer

    -

    Parameters

    • peer: PeerId
    • data: {
          messages?: Message[];
          subscribe?: boolean;
          subscriptions?: string[];
      }
      • Optional messages?: Message[]
      • Optional subscribe?: boolean
      • Optional subscriptions?: string[]

    Returns void

sendRpc

start

stop

subscribe

unsubscribe

validate

removeEventListener

safeDispatchEvent

send

  • send(peer, data): void

  • Send an rpc object to a peer

    +

    Parameters

    • peer: PeerId
    • data: {
          messages?: Message[];
          subscribe?: boolean;
          subscriptions?: string[];
      }
      • Optional messages?: Message[]
      • Optional subscribe?: boolean
      • Optional subscriptions?: string[]

    Returns void

sendRpc

start

stop

subscribe

unsubscribe

validate

Settings

Member Visibility

Theme

On This Page

constructor#private_registrarTopologyIdscanRelayMessagecomponentsemitSelfenabledglobalSignaturePolicylogmaxInboundStreamsmaxOutboundStreamsmulticodecspeersqueuestartedsubscriptionstopicValidatorstopics_onIncomingStream_onPeerConnected_onPeerDisconnected_removePeeracceptFromaddEventListeneraddPeerbuildMessagedecodeRpcdispatchEventencodeMessageencodeRpcgetMsgIdgetPeersgetSubscribersgetTopicsisStartedlistenerCountprocessMessageprocessMessagesprocessRpcprocessRpcSubOptpublishpublishMessageremoveEventListenersafeDispatchEventsendsendRpcstartstopsubscribeunsubscribevalidate
\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructor#private_registrarTopologyIdscanRelayMessagecomponentsemitSelfenabledglobalSignaturePolicylogmaxInboundStreamsmaxOutboundStreamsmulticodecspeersqueuestartedsubscriptionstopicValidatorstopics_onIncomingStream_onPeerConnected_onPeerDisconnected_removePeeracceptFromaddEventListeneraddPeerbuildMessagedecodeRpcdispatchEventencodeMessageencodeRpcgetMsgIdgetPeersgetSubscribersgetTopicsisStartedlistenerCountprocessMessageprocessMessagesprocessRpcprocessRpcSubOptpublishpublishMessageremoveEventListenersafeDispatchEventsendsendRpcstartstopsubscribeunsubscribevalidate
\ No newline at end of file diff --git a/classes/_libp2p_pubsub.peer_streams.PeerStreams.html b/classes/_libp2p_pubsub.peer_streams.PeerStreams.html index b42eea376e..3503bcecc3 100644 --- a/classes/_libp2p_pubsub.peer_streams.PeerStreams.html +++ b/classes/_libp2p_pubsub.peer_streams.PeerStreams.html @@ -1,5 +1,5 @@ PeerStreams | libp2p

Class PeerStreams

Thin wrapper around a peer's inbound / outbound pubsub streams

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

#private _inboundAbortController _rawInboundStream? @@ -21,18 +21,18 @@ removeEventListener safeDispatchEvent write -

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly _inboundAbortController

_inboundAbortController: AbortController

An AbortController for controlled shutdown of the inbound stream

-

Private Optional _rawInboundStream

_rawInboundStream?: Stream

The raw inbound stream, as retrieved from the callback from libp2p.handle

-

Private Optional _rawOutboundStream

_rawOutboundStream?: Stream

The raw outbound stream, as retrieved from conn.newStream

-

Private closed

closed: boolean

Readonly id

id: PeerId

Optional inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

Read stream

-

Private Readonly log

log: Logger

Optional outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

Write stream - it's preferable to use the write method

-

Readonly protocol

protocol: string

Accessors

isReadable

isWritable

Methods

addEventListener

attachInboundStream

attachOutboundStream

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    +

Constructors

constructor

Properties

Private #private

#private: any

Private Readonly _inboundAbortController

_inboundAbortController: AbortController

An AbortController for controlled shutdown of the inbound stream

+

Private Optional _rawInboundStream

_rawInboundStream?: Stream

The raw inbound stream, as retrieved from the callback from libp2p.handle

+

Private Optional _rawOutboundStream

_rawOutboundStream?: Stream

The raw outbound stream, as retrieved from conn.newStream

+

Private closed

closed: boolean

Readonly id

id: PeerId

Optional inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

Read stream

+

Private Readonly log

log: Logger

Optional outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

Write stream - it's preferable to use the write method

+

Readonly protocol

protocol: string

Accessors

isReadable

isWritable

Methods

addEventListener

attachInboundStream

attachOutboundStream

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

removeEventListener

safeDispatchEvent

write

Settings

Member Visibility

Theme

On This Page

constructor#private_inboundAbortController_rawInboundStream_rawOutboundStreamclosedidinboundStreamlogoutboundStreamprotocolisReadableisWritableaddEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

constructor#private_inboundAbortController_rawInboundStream_rawOutboundStreamclosedidinboundStreamlogoutboundStreamprotocolisReadableisWritableaddEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
\ No newline at end of file diff --git a/classes/_libp2p_record.Libp2pRecord.html b/classes/_libp2p_record.Libp2pRecord.html index 49ec5013db..ccd0b9cb96 100644 --- a/classes/_libp2p_record.Libp2pRecord.html +++ b/classes/_libp2p_record.Libp2pRecord.html @@ -1,4 +1,4 @@ -Libp2pRecord | libp2p

Class Libp2pRecord

Constructors

constructor +Libp2pRecord | libp2p

Class Libp2pRecord

Constructors

constructor

Properties

key timeReceived value @@ -6,7 +6,7 @@ serialize deserialize fromDeserialized -

Constructors

constructor

Properties

key

key: Uint8Array

timeReceived

timeReceived: Date

value

value: Uint8Array

Methods

prepareSerialize

  • prepareSerialize(): Record

  • Return the object format ready to be given to the protobuf library.

    -

    Returns Record

serialize

Static deserialize

Static fromDeserialized

Settings

Member Visibility

Theme

On This Page

constructorkeytimeReceivedvalueprepareSerializeserializedeserializefromDeserialized
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

timeReceived

timeReceived: Date

value

value: Uint8Array

Methods

prepareSerialize

  • prepareSerialize(): Record

  • Return the object format ready to be given to the protobuf library.

    +

    Returns Record

serialize

Static deserialize

Static fromDeserialized

Settings

Member Visibility

Theme

On This Page

constructorkeytimeReceivedvalueprepareSerializeserializedeserializefromDeserialized
\ No newline at end of file diff --git a/classes/_libp2p_utils.abstract_stream.AbstractStream.html b/classes/_libp2p_utils.abstract_stream.AbstractStream.html index 0225da610a..49c339c888 100644 --- a/classes/_libp2p_utils.abstract_stream.AbstractStream.html +++ b/classes/_libp2p_utils.abstract_stream.AbstractStream.html @@ -2,7 +2,7 @@ can be written to and read from at both ends.

It may be encrypted and multiplexed depending on the configuration of the nodes.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

closed direction endErr @@ -46,44 +46,44 @@ sink sourcePush sourceReadableLength -

Constructors

constructor

Properties

Private Readonly closed

closed: DeferredPromise<void>

direction

direction: Direction

Outbound streams are opened by the local node, inbound streams are opened by the remote

-

Private endErr

endErr: undefined | Error

id

id: string

Unique identifier for a stream. Identifiers are not unique across muxers.

-

Readonly log

log: Logger

The stream logger

-

metadata

metadata: Record<string, unknown>

User defined stream metadata

-

Private Optional Readonly onAbort

onAbort?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      Returns void

Private Optional Readonly onCloseRead

onCloseRead?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onCloseWrite

onCloseWrite?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onEnd

onEnd?: ((err?) => void)

Type declaration

    • (err?): void

    • Parameters

      Returns void

Private Optional Readonly onReset

onReset?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional protocol

protocol?: string

The protocol negotiated for this stream

-

readStatus

readStatus: ReadStatus

The current status of the readable end of the stream

-

Private Readonly sendCloseWriteTimeout

sendCloseWriteTimeout: number

Private Optional sendingData

sendingData?: DeferredPromise<void>

Private Readonly sinkController

sinkController: AbortController

Private Readonly sinkEnd

sinkEnd: DeferredPromise<void>

source

source: AsyncGenerator<Uint8ArrayList, void, unknown>

status

status: StreamStatus

The current status of the stream

-

Private Readonly streamSource

streamSource: Pushable<Uint8ArrayList, void, unknown>

timeline

timeline: StreamTimeline

Lifecycle times for the stream

-

writeStatus

writeStatus: WriteStatus

The current status of the writable end of the stream

-

Methods

_closeSink

_closeSinkAndSource

_closeSource

abort

  • abort(err): void

  • Close immediately for reading and writing and send a reset message (local +

Constructors

constructor

Properties

Private Readonly closed

closed: DeferredPromise<void>

direction

direction: Direction

Outbound streams are opened by the local node, inbound streams are opened by the remote

+

Private endErr

endErr: undefined | Error

id

id: string

Unique identifier for a stream. Identifiers are not unique across muxers.

+

Readonly log

log: Logger

The stream logger

+

metadata

metadata: Record<string, unknown>

User defined stream metadata

+

Private Optional Readonly onAbort

onAbort?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      Returns void

Private Optional Readonly onCloseRead

onCloseRead?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onCloseWrite

onCloseWrite?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional Readonly onEnd

onEnd?: ((err?) => void)

Type declaration

    • (err?): void

    • Parameters

      Returns void

Private Optional Readonly onReset

onReset?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional protocol

protocol?: string

The protocol negotiated for this stream

+

readStatus

readStatus: ReadStatus

The current status of the readable end of the stream

+

Private Readonly sendCloseWriteTimeout

sendCloseWriteTimeout: number

Private Optional sendingData

sendingData?: DeferredPromise<void>

Private Readonly sinkController

sinkController: AbortController

Private Readonly sinkEnd

sinkEnd: DeferredPromise<void>

source

source: AsyncGenerator<Uint8ArrayList, void, unknown>

status

status: StreamStatus

The current status of the stream

+

Private Readonly streamSource

streamSource: Pushable<Uint8ArrayList, void, unknown>

timeline

timeline: StreamTimeline

Lifecycle times for the stream

+

writeStatus

writeStatus: WriteStatus

The current status of the writable end of the stream

+

Methods

_closeSink

_closeSinkAndSource

_closeSource

abort

close

close

  • close(options?): Promise<void>

  • Closes the stream for reading and writing.

    Any buffered data in the source can still be consumed and the stream will end normally.

    This will cause a CLOSE message to be sent to the remote, unless the sink has already ended.

    The sink and the source will return normally.

    -

    Parameters

    Returns Promise<void>

closeRead

closeRead

  • closeRead(options?): Promise<void>

  • Closes the stream for reading. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

    This function is called automatically by the muxer when it receives a CLOSE message from the remote.

    The source will return normally, the sink will continue to consume.

    -

    Parameters

    Returns Promise<void>

closeWrite

closeWrite

  • closeWrite(options?): Promise<void>

  • Closes the stream for writing. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

    The source will return normally, the sink will continue to consume.

    -

    Parameters

    Returns Promise<void>

destroy

destroy

Protected onSinkEnd

Protected onSourceEnd

remoteCloseRead

Protected onSinkEnd

Protected onSourceEnd

remoteCloseRead

remoteCloseWrite

remoteCloseWrite

reset

reset

Abstract sendCloseRead

Abstract sendCloseRead

Abstract sendCloseWrite

Abstract sendCloseWrite

Abstract sendData

Abstract sendNewStream

Abstract sendData

Abstract sendNewStream

Abstract sendReset

sink

sourcePush

Abstract sendReset

sink

sourcePush

sourceReadableLength

sourceReadableLength

  • sourceReadableLength(): number

  • Returns the amount of unread data - can be used to prevent large amounts of data building up when the stream consumer is too slow.

    -

    Returns number

Settings

Member Visibility

Theme

On This Page

constructorcloseddirectionendErridlogmetadataonAbortonCloseReadonCloseWriteonEndonResetprotocolreadStatussendCloseWriteTimeoutsendingDatasinkControllersinkEndsourcestatusstreamSourcetimelinewriteStatus_closeSink_closeSinkAndSource_closeSourceabortclosecloseReadcloseWritedestroyonSinkEndonSourceEndremoteCloseReadremoteCloseWriteresetsendCloseReadsendCloseWritesendDatasendNewStreamsendResetsinksourcePushsourceReadableLength
\ No newline at end of file +

Returns number

Settings

Member Visibility

Theme

On This Page

constructorcloseddirectionendErridlogmetadataonAbortonCloseReadonCloseWriteonEndonResetprotocolreadStatussendCloseWriteTimeoutsendingDatasinkControllersinkEndsourcestatusstreamSourcetimelinewriteStatus_closeSink_closeSinkAndSource_closeSourceabortclosecloseReadcloseWritedestroyonSinkEndonSourceEndremoteCloseReadremoteCloseWriteresetsendCloseReadsendCloseWritesendDatasendNewStreamsendResetsinksourcePushsourceReadableLength
\ No newline at end of file diff --git a/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html b/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html index ec641bc631..b9967fa0bd 100644 --- a/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html +++ b/classes/_libp2p_utils.adaptive_timeout.AdaptiveTimeout.html @@ -1,4 +1,4 @@ -AdaptiveTimeout | libp2p

Class AdaptiveTimeout

Constructors

constructor +AdaptiveTimeout | libp2p

Class AdaptiveTimeout

Constructors

constructor

Properties

failure failureMultiplier metric? @@ -8,4 +8,4 @@ timeoutMultiplier

Methods

cleanUp getTimeoutSignal -

Constructors

constructor

Properties

Private Readonly failure

failure: MovingAverage

Private Readonly failureMultiplier

failureMultiplier: number

Private Optional Readonly metric

metric?: MetricGroup

Private Readonly minTimeout

minTimeout: number

Private Readonly next

next: MovingAverage

Private Readonly success

success: MovingAverage

Private Readonly timeoutMultiplier

timeoutMultiplier: number

Methods

cleanUp

getTimeoutSignal

Settings

Member Visibility

Theme

On This Page

constructorfailurefailureMultipliermetricminTimeoutnextsuccesstimeoutMultipliercleanUpgetTimeoutSignal
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly failure

failure: MovingAverage

Private Readonly failureMultiplier

failureMultiplier: number

Private Optional Readonly metric

metric?: MetricGroup

Private Readonly minTimeout

minTimeout: number

Private Readonly next

next: MovingAverage

Private Readonly success

success: MovingAverage

Private Readonly timeoutMultiplier

timeoutMultiplier: number

Methods

cleanUp

getTimeoutSignal

Settings

Member Visibility

Theme

On This Page

constructorfailurefailureMultipliermetricminTimeoutnextsuccesstimeoutMultipliercleanUpgetTimeoutSignal
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.BloomFilter.html b/classes/_libp2p_utils.filters.BloomFilter.html index df005e610c..99ad7d2808 100644 --- a/classes/_libp2p_utils.filters.BloomFilter.html +++ b/classes/_libp2p_utils.filters.BloomFilter.html @@ -1,4 +1,4 @@ -BloomFilter | libp2p

Class BloomFilter

Implements

Constructors

constructor +BloomFilter | libp2p

Class BloomFilter

Implements

Constructors

constructor

Properties

bits buffer seeds @@ -7,9 +7,9 @@ getbit has setbit -

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

  • Test if the filter has an item. If it returns false it definitely does not +

Constructors

constructor

Properties

Readonly bits

bits: number

buffer

buffer: Uint8Array

Readonly seeds

seeds: number[]

Methods

add

clear

getbit

has

  • has(item): boolean

  • Test if the filter has an item. If it returns false it definitely does not have the item. If it returns true, it probably has the item but there's an errorRate chance it doesn't.

    -

    Parameters

    Returns boolean

setbit

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbit
\ No newline at end of file +

Parameters

Returns boolean

setbit

Settings

Member Visibility

Theme

On This Page

constructorbitsbufferseedsaddcleargetbithassetbit
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.CuckooFilter.html b/classes/_libp2p_utils.filters.CuckooFilter.html index f847772056..26152b9379 100644 --- a/classes/_libp2p_utils.filters.CuckooFilter.html +++ b/classes/_libp2p_utils.filters.CuckooFilter.html @@ -1,4 +1,4 @@ -CuckooFilter | libp2p

Class CuckooFilter

Implements

Constructors

constructor +CuckooFilter | libp2p

Class CuckooFilter

Implements

Constructors

constructor

Properties

bucketSize buckets count @@ -10,4 +10,4 @@

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly buckets

buckets: Bucket[]

count

count: number

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly seed

seed: number

Accessors

reliable

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizebucketscountfilterSizefingerprintSizehashseedreliableaddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly buckets

buckets: Bucket[]

count

count: number

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly seed

seed: number

Accessors

reliable

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizebucketscountfilterSizefingerprintSizehashseedreliableaddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_utils.filters.ScalableCuckooFilter.html b/classes/_libp2p_utils.filters.ScalableCuckooFilter.html index cc5fc575d5..77b587b5e6 100644 --- a/classes/_libp2p_utils.filters.ScalableCuckooFilter.html +++ b/classes/_libp2p_utils.filters.ScalableCuckooFilter.html @@ -1,4 +1,4 @@ -ScalableCuckooFilter | libp2p

Class ScalableCuckooFilter

Implements

Constructors

constructor +ScalableCuckooFilter | libp2p

Class ScalableCuckooFilter

Implements

Constructors

constructor

Properties

bucketSize filterSeries filterSize @@ -10,4 +10,4 @@

Methods

add has remove -

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly filterSeries

filterSeries: CuckooFilter[]

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly scale

scale: number

Private Readonly seed

seed: number

Accessors

count

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizefilterSeriesfilterSizefingerprintSizehashscaleseedcountaddhasremove
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly bucketSize

bucketSize: number

Private Readonly filterSeries

filterSeries: CuckooFilter[]

Private Readonly filterSize

filterSize: number

Private Readonly fingerprintSize

fingerprintSize: number

Private Readonly hash

hash: Hash

Private Readonly scale

scale: number

Private Readonly seed

seed: number

Accessors

count

Methods

add

has

remove

Settings

Member Visibility

Theme

On This Page

constructorbucketSizefilterSeriesfilterSizefingerprintSizehashscaleseedcountaddhasremove
\ No newline at end of file diff --git a/classes/_libp2p_utils.moving_average.MovingAverage.html b/classes/_libp2p_utils.moving_average.MovingAverage.html index 3b2a981201..9f646294ba 100644 --- a/classes/_libp2p_utils.moving_average.MovingAverage.html +++ b/classes/_libp2p_utils.moving_average.MovingAverage.html @@ -3,7 +3,7 @@
  • https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
  • https://www.npmjs.com/package/moving-average
    • -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    deviation forecast movingAverage @@ -12,4 +12,4 @@ variance

    Methods

    alpha push -

    Constructors

    constructor

    Properties

    deviation

    deviation: number

    forecast

    forecast: number

    movingAverage

    movingAverage: number

    Private Optional previousTime

    previousTime?: number

    Private Readonly timespan

    timespan: number

    variance

    variance: number

    Methods

    alpha

    push

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeviationforecastmovingAveragepreviousTimetimespanvariancealphapush
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    deviation

    deviation: number

    forecast

    forecast: number

    movingAverage

    movingAverage: number

    Private Optional previousTime

    previousTime?: number

    Private Readonly timespan

    timespan: number

    variance

    variance: number

    Methods

    alpha

    push

    Settings

    Member Visibility

    Theme

    On This Page

    constructordeviationforecastmovingAveragepreviousTimetimespanvariancealphapush
    \ No newline at end of file diff --git a/classes/_libp2p_utils.peer_queue.PeerQueue.html b/classes/_libp2p_utils.peer_queue.PeerQueue.html index dd41d60a81..5c8facb866 100644 --- a/classes/_libp2p_utils.peer_queue.PeerQueue.html +++ b/classes/_libp2p_utils.peer_queue.PeerQueue.html @@ -1,5 +1,5 @@ PeerQueue | libp2p

    Class PeerQueue<JobReturnType, JobOptions>

    Extends Queue to add support for querying queued jobs by peer id

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency queue @@ -20,32 +20,32 @@ removeEventListener safeDispatchEvent toGenerator -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      -

      Parameters

      Returns boolean

    find

    has

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    • onEmpty(options?): Promise<void>

    • Can be called multiple times. Useful if you for example add additional items at a later time.

      +

      Parameters

      Returns boolean

    find

    has

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    onIdle

    onIdle

    • onIdle(options?): Promise<void>

    • The difference with .onEmpty is that .onIdle guarantees that all work from the queue has finished. .onEmpty merely signals that the queue is empty, but it could mean that some promises haven't completed yet.

      Parameters

      Returns Promise<void>

      A promise that settles when the queue becomes empty, and all promises have completed; queue.size === 0 && queue.pending === 0.

      -

    onSizeLessThan

    onSizeLessThan

    • onSizeLessThan(limit, options?): Promise<void>

    • Parameters

      Returns Promise<void>

      A promise that settles when the queue size is less than the given limit: queue.size < limit.

      If you want to avoid having the queue grow beyond a certain size you can await queue.onSizeLessThan() before adding a new item.

      Note that this only limits the number of items waiting to start. There could still be up to concurrency jobs already running that this call does not include in its calculation.

      -

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencyqueuequeuedrunningsizeabortaddaddEventListenercleardispatchEventfindhaslistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencyqueuequeuedrunningsizeabortaddaddEventListenercleardispatchEventfindhaslistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file diff --git a/classes/_libp2p_utils.priority_queue.PriorityQueue.html b/classes/_libp2p_utils.priority_queue.PriorityQueue.html index 593dac0671..8ad746ad16 100644 --- a/classes/_libp2p_utils.priority_queue.PriorityQueue.html +++ b/classes/_libp2p_utils.priority_queue.PriorityQueue.html @@ -3,7 +3,7 @@
  • Items remain at the head of the queue while they are running so queue.size includes queue.pending items - this is so interested parties can join the results of a queue item while it is running
  • The options for a job are stored separately to the job in order for them to be modified while they are still in the queue
    • -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency queue @@ -22,32 +22,32 @@ removeEventListener safeDispatchEvent toGenerator -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    onIdle

    onIdle

    • onIdle(options?): Promise<void>

    • The difference with .onEmpty is that .onIdle guarantees that all work from the queue has finished. .onEmpty merely signals that the queue is empty, but it could mean that some promises haven't completed yet.

      Parameters

      Returns Promise<void>

      A promise that settles when the queue becomes empty, and all promises have completed; queue.size === 0 && queue.pending === 0.

      -

    onSizeLessThan

    onSizeLessThan

    • onSizeLessThan(limit, options?): Promise<void>

    • Parameters

      Returns Promise<void>

      A promise that settles when the queue size is less than the given limit: queue.size < limit.

      If you want to avoid having the queue grow beyond a certain size you can await queue.onSizeLessThan() before adding a new item.

      Note that this only limits the number of items waiting to start. There could still be up to concurrency jobs already running that this call does not include in its calculation.

      -

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencyqueuequeuedrunningsizeabortaddaddEventListenercleardispatchEventlistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencyqueuequeuedrunningsizeabortaddaddEventListenercleardispatchEventlistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGenerator
    \ No newline at end of file diff --git a/classes/_libp2p_utils.queue.Queue.html b/classes/_libp2p_utils.queue.Queue.html index 6f680a4dd9..239c1d696f 100644 --- a/classes/_libp2p_utils.queue.Queue.html +++ b/classes/_libp2p_utils.queue.Queue.html @@ -3,7 +3,7 @@
  • Items remain at the head of the queue while they are running so queue.size includes queue.pending items - this is so interested parties can join the results of a queue item while it is running
  • The options for a job are stored separately to the job in order for them to be modified while they are still in the queue
    • -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    #private concurrency pending @@ -26,32 +26,32 @@ safeDispatchEvent toGenerator tryToStartAnother -

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    Private pending

    pending: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Private Optional Readonly sort

    sort?: Comparator<Job<JobOptions, JobReturnType>>

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Constructors

    constructor

    Properties

    Private #private

    #private: any

    concurrency

    concurrency: number

    Private pending

    pending: number

    queue

    queue: Job<JobOptions, JobReturnType>[]

    Private Optional Readonly sort

    sort?: Comparator<Job<JobOptions, JobReturnType>>

    Accessors

    queued

    running

    size

    Methods

    abort

    add

    addEventListener

    clear

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      -

      Parameters

      Returns boolean

    Private enqueue

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    • onEmpty(options?): Promise<void>

    • Can be called multiple times. Useful if you for example add additional items at a later time.

      +

      Parameters

      Returns boolean

    Private enqueue

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    onEmpty

    onIdle

    onIdle

    • onIdle(options?): Promise<void>

    • The difference with .onEmpty is that .onIdle guarantees that all work from the queue has finished. .onEmpty merely signals that the queue is empty, but it could mean that some promises haven't completed yet.

      Parameters

      Returns Promise<void>

      A promise that settles when the queue becomes empty, and all promises have completed; queue.size === 0 && queue.pending === 0.

      -

    onSizeLessThan

    onSizeLessThan

    • onSizeLessThan(limit, options?): Promise<void>

    • Parameters

      Returns Promise<void>

      A promise that settles when the queue size is less than the given limit: queue.size < limit.

      If you want to avoid having the queue grow beyond a certain size you can await queue.onSizeLessThan() before adding a new item.

      Note that this only limits the number of items waiting to start. There could still be up to concurrency jobs already running that this call does not include in its calculation.

      -

    removeEventListener

    safeDispatchEvent

    toGenerator

    removeEventListener

    safeDispatchEvent

    toGenerator

    • toGenerator(options?): AsyncGenerator<JobReturnType, void, unknown>

    • Returns an async generator that makes it easy to iterate over the results of jobs added to the queue.

      The generator will end when the queue becomes idle, that is there are no jobs running and no jobs that have yet to run.

      If you need to keep the queue open indefinitely, consider using it-pushable instead.

      -

      Parameters

      Returns AsyncGenerator<JobReturnType, void, unknown>

    Private tryToStartAnother

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencypendingqueuesortqueuedrunningsizeabortaddaddEventListenercleardispatchEventenqueuelistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGeneratortryToStartAnother
    \ No newline at end of file +

    Parameters

    Returns AsyncGenerator<JobReturnType, void, unknown>

    Private tryToStartAnother

    Settings

    Member Visibility

    Theme

    On This Page

    constructor#privateconcurrencypendingqueuesortqueuedrunningsizeabortaddaddEventListenercleardispatchEventenqueuelistenerCountonEmptyonIdleonSizeLessThanremoveEventListenersafeDispatchEventtoGeneratortryToStartAnother
    \ No newline at end of file diff --git a/classes/_libp2p_utils.rate_limiter.RateLimiter.html b/classes/_libp2p_utils.rate_limiter.RateLimiter.html index 5bfa9c90cc..876222bd0a 100644 --- a/classes/_libp2p_utils.rate_limiter.RateLimiter.html +++ b/classes/_libp2p_utils.rate_limiter.RateLimiter.html @@ -1,4 +1,4 @@ -RateLimiter | libp2p

    Class RateLimiter

    Constructors

    constructor +RateLimiter | libp2p

    Class RateLimiter

    Constructors

    constructor

    Properties

    blockDuration duration execEvenly @@ -16,5 +16,5 @@ penalty reward set -

    Constructors

    constructor

    Properties

    Protected blockDuration

    blockDuration: number

    Protected duration

    duration: number

    Protected execEvenly

    execEvenly: boolean

    Protected execEvenlyMinDelayMs

    execEvenlyMinDelayMs: number

    Protected keyPrefix

    keyPrefix: string

    Readonly memoryStorage

    memoryStorage: MemoryStorage

    Protected points

    points: number

    Methods

    Private _getKeySecDuration

    block

    consume

    delete

    get

    getKey

    parseKey

    penalty

    reward

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixmemoryStoragepoints_getKeySecDurationblockconsumedeletegetgetKeyparseKeypenaltyrewardset
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected blockDuration

    blockDuration: number

    Protected duration

    duration: number

    Protected execEvenly

    execEvenly: boolean

    Protected execEvenlyMinDelayMs

    execEvenlyMinDelayMs: number

    Protected keyPrefix

    keyPrefix: string

    Readonly memoryStorage

    memoryStorage: MemoryStorage

    Protected points

    points: number

    Methods

    Private _getKeySecDuration

    block

    consume

    delete

    get

    getKey

    parseKey

    penalty

    reward

    set

    Settings

    Member Visibility

    Theme

    On This Page

    constructorblockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixmemoryStoragepoints_getKeySecDurationblockconsumedeletegetgetKeyparseKeypenaltyrewardset
    \ No newline at end of file diff --git a/enums/_libp2p_crypto.keys.keysPBM.KeyType-1.html b/enums/_libp2p_crypto.keys.keysPBM.KeyType-1.html index b7a4ce705f..1f6fb6c3a8 100644 --- a/enums/_libp2p_crypto.keys.keysPBM.KeyType-1.html +++ b/enums/_libp2p_crypto.keys.keysPBM.KeyType-1.html @@ -1,4 +1,4 @@ -KeyType | libp2p

    Enumeration KeyType

    Enumeration Members

    Ed25519 +KeyType | libp2p

    Enumeration KeyType

    Enumeration Members

    Ed25519 RSA Secp256k1 -

    Enumeration Members

    Ed25519

    Ed25519: "Ed25519"

    RSA

    RSA: "RSA"

    Secp256k1

    Secp256k1: "Secp256k1"

    Settings

    Member Visibility

    Theme

    On This Page

    Ed25519RSASecp256k1
    \ No newline at end of file +

    Enumeration Members

    Ed25519

    Ed25519: "Ed25519"

    RSA

    RSA: "RSA"

    Secp256k1

    Secp256k1: "Secp256k1"

    Settings

    Member Visibility

    Theme

    On This Page

    Ed25519RSASecp256k1
    \ No newline at end of file diff --git a/enums/_libp2p_interface.FaultTolerance.html b/enums/_libp2p_interface.FaultTolerance.html index 169005e6f1..2c98e52c83 100644 --- a/enums/_libp2p_interface.FaultTolerance.html +++ b/enums/_libp2p_interface.FaultTolerance.html @@ -1,6 +1,6 @@ FaultTolerance | libp2p

    Enumeration FaultTolerance

    Enum Transport Manager Fault Tolerance values

    -

    Enumeration Members

    FATAL_ALL +

    Enumeration Members

    FATAL_ALL NO_FATAL

    Enumeration Members

    FATAL_ALL

    FATAL_ALL: 0

    should be used for failing in any listen circumstance

    -

    NO_FATAL

    NO_FATAL: 1

    should be used for not failing when not listening

    -

    Settings

    Member Visibility

    Theme

    On This Page

    FATAL_ALLNO_FATAL
    \ No newline at end of file +

    NO_FATAL

    NO_FATAL: 1

    should be used for not failing when not listening

    +

    Settings

    Member Visibility

    Theme

    On This Page

    FATAL_ALLNO_FATAL
    \ No newline at end of file diff --git a/enums/_libp2p_interface.TopicValidatorResult.html b/enums/_libp2p_interface.TopicValidatorResult.html index 51a6e454ad..6e7a46cad6 100644 --- a/enums/_libp2p_interface.TopicValidatorResult.html +++ b/enums/_libp2p_interface.TopicValidatorResult.html @@ -1,7 +1,7 @@ -TopicValidatorResult | libp2p

    Enumeration TopicValidatorResult

    Enumeration Members

    Accept +TopicValidatorResult | libp2p

    Enumeration TopicValidatorResult

    Enumeration Members

    Accept Ignore Reject

    Enumeration Members

    Accept

    Accept: "accept"

    The message is considered valid, and it should be delivered and forwarded to the network

    -

    Ignore

    Ignore: "ignore"

    The message is neither delivered nor forwarded to the network

    -

    Reject

    Reject: "reject"

    The message is considered invalid, and it should be rejected

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AcceptIgnoreReject
    \ No newline at end of file +

    Ignore

    Ignore: "ignore"

    The message is neither delivered nor forwarded to the network

    +

    Reject

    Reject: "reject"

    The message is considered invalid, and it should be rejected

    +

    Settings

    Member Visibility

    Theme

    On This Page

    AcceptIgnoreReject
    \ No newline at end of file diff --git a/enums/_libp2p_kad_dht.EventTypes.html b/enums/_libp2p_kad_dht.EventTypes.html index ec5e43ca52..f9f9b694eb 100644 --- a/enums/_libp2p_kad_dht.EventTypes.html +++ b/enums/_libp2p_kad_dht.EventTypes.html @@ -1,5 +1,5 @@ EventTypes | libp2p

    Enumeration EventTypes

    The types of events emitted during DHT queries

    -

    Enumeration Members

    ADD_PEER +

    Enumeration Members

    ADD_PEER DIAL_PEER FINAL_PEER PEER_RESPONSE @@ -7,4 +7,4 @@ QUERY_ERROR SEND_QUERY VALUE -

    Enumeration Members

    ADD_PEER

    ADD_PEER: 6

    DIAL_PEER

    DIAL_PEER: 7

    FINAL_PEER

    FINAL_PEER: 2

    PEER_RESPONSE

    PEER_RESPONSE: 1

    PROVIDER

    PROVIDER: 4

    QUERY_ERROR

    QUERY_ERROR: 3

    SEND_QUERY

    SEND_QUERY: 0

    VALUE

    VALUE: 5

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PEERDIAL_PEERFINAL_PEERPEER_RESPONSEPROVIDERQUERY_ERRORSEND_QUERYVALUE
    \ No newline at end of file +

    Enumeration Members

    ADD_PEER

    ADD_PEER: 6

    DIAL_PEER

    DIAL_PEER: 7

    FINAL_PEER

    FINAL_PEER: 2

    PEER_RESPONSE

    PEER_RESPONSE: 1

    PROVIDER

    PROVIDER: 4

    QUERY_ERROR

    QUERY_ERROR: 3

    SEND_QUERY

    SEND_QUERY: 0

    VALUE

    VALUE: 5

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PEERDIAL_PEERFINAL_PEERPEER_RESPONSEPROVIDERQUERY_ERRORSEND_QUERYVALUE
    \ No newline at end of file diff --git a/enums/_libp2p_kad_dht.MessageType-1.html b/enums/_libp2p_kad_dht.MessageType-1.html index 007ed048d3..52159ff8d2 100644 --- a/enums/_libp2p_kad_dht.MessageType-1.html +++ b/enums/_libp2p_kad_dht.MessageType-1.html @@ -1,7 +1,7 @@ -MessageType | libp2p

    Enumeration MessageType

    Enumeration Members

    ADD_PROVIDER +MessageType | libp2p

    Enumeration MessageType

    Enumeration Members

    ADD_PROVIDER FIND_NODE GET_PROVIDERS GET_VALUE PING PUT_VALUE -

    Enumeration Members

    ADD_PROVIDER

    ADD_PROVIDER: "ADD_PROVIDER"

    FIND_NODE

    FIND_NODE: "FIND_NODE"

    GET_PROVIDERS

    GET_PROVIDERS: "GET_PROVIDERS"

    GET_VALUE

    GET_VALUE: "GET_VALUE"

    PING

    PING: "PING"

    PUT_VALUE

    PUT_VALUE: "PUT_VALUE"

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PROVIDERFIND_NODEGET_PROVIDERSGET_VALUEPINGPUT_VALUE
    \ No newline at end of file +

    Enumeration Members

    ADD_PROVIDER

    ADD_PROVIDER: "ADD_PROVIDER"

    FIND_NODE

    FIND_NODE: "FIND_NODE"

    GET_PROVIDERS

    GET_PROVIDERS: "GET_PROVIDERS"

    GET_VALUE

    GET_VALUE: "GET_VALUE"

    PING

    PING: "PING"

    PUT_VALUE

    PUT_VALUE: "PUT_VALUE"

    Settings

    Member Visibility

    Theme

    On This Page

    ADD_PROVIDERFIND_NODEGET_PROVIDERSGET_VALUEPINGPUT_VALUE
    \ No newline at end of file diff --git a/functions/_libp2p_autonat.autoNAT.html b/functions/_libp2p_autonat.autoNAT.html index 4117cf6f54..9221c69850 100644 --- a/functions/_libp2p_autonat.autoNAT.html +++ b/functions/_libp2p_autonat.autoNAT.html @@ -1 +1 @@ -autoNAT | libp2p

    Function autoNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +autoNAT | libp2p

    Function autoNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_bootstrap.bootstrap.html b/functions/_libp2p_bootstrap.bootstrap.html index cb34a30268..48a42da9c5 100644 --- a/functions/_libp2p_bootstrap.bootstrap.html +++ b/functions/_libp2p_bootstrap.bootstrap.html @@ -1 +1 @@ -bootstrap | libp2p

    Function bootstrap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bootstrap | libp2p

    Function bootstrap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html b/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html index f4dd8eee20..67a86606f1 100644 --- a/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html +++ b/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html @@ -1 +1 @@ -circuitRelayServer | libp2p

    Function circuitRelayServer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +circuitRelayServer | libp2p

    Function circuitRelayServer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html b/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html index e9a3702324..d80a45e7fe 100644 --- a/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html +++ b/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html @@ -1 +1 @@ -circuitRelayTransport | libp2p

    Function circuitRelayTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +circuitRelayTransport | libp2p

    Function circuitRelayTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.hmac.create.html b/functions/_libp2p_crypto.hmac.create.html index 256941b94d..7d0d8ebd2a 100644 --- a/functions/_libp2p_crypto.hmac.create.html +++ b/functions/_libp2p_crypto.hmac.create.html @@ -1 +1 @@ -create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +create | libp2p

    Function create

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.index.pbkdf2.html b/functions/_libp2p_crypto.index.pbkdf2.html index ad664d14f3..4935a57710 100644 --- a/functions/_libp2p_crypto.index.pbkdf2.html +++ b/functions/_libp2p_crypto.index.pbkdf2.html @@ -1,2 +1,2 @@ pbkdf2 | libp2p

    Function pbkdf2

    • pbkdf2(password, salt, iterations, keySize, hash): string

    • Computes the Password-Based Key Derivation Function 2.

      -

      Parameters

      • password: string
      • salt: string | Uint8Array
      • iterations: number
      • keySize: number
      • hash: string

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.index.randomBytes.html b/functions/_libp2p_crypto.index.randomBytes.html index 51ee6eac27..e21544b096 100644 --- a/functions/_libp2p_crypto.index.randomBytes.html +++ b/functions/_libp2p_crypto.index.randomBytes.html @@ -1,2 +1,2 @@ randomBytes | libp2p

    Function randomBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html b/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html index 2cfb494f22..cd7f87801c 100644 --- a/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html +++ b/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html @@ -1,3 +1,3 @@ generateEphemeralKeyPair | libp2p

    Function generateEphemeralKeyPair

    • generateEphemeralKeyPair(curve): Promise<ECDHKey>

    • Generates an ephemeral public key and returns a function that will compute the shared secret key.

      Focuses only on ECDH now, but can be made more general in the future.

      -

      Parameters

      • curve: string

      Returns Promise<ECDHKey>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<ECDHKey>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateKeyPair.html b/functions/_libp2p_crypto.keys.generateKeyPair.html index 38304f9198..bc8b29cbcf 100644 --- a/functions/_libp2p_crypto.keys.generateKeyPair.html +++ b/functions/_libp2p_crypto.keys.generateKeyPair.html @@ -1,2 +1,2 @@ generateKeyPair | libp2p

    Function generateKeyPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<PrivateKey<T>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html b/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html index 70ff0208b1..80587163e8 100644 --- a/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html +++ b/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html @@ -1,3 +1,3 @@ generateKeyPairFromSeed | libp2p

    Function generateKeyPairFromSeed

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<PrivateKey<T>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.importKey.html b/functions/_libp2p_crypto.keys.importKey.html index b0f5ae20cb..72692ef3db 100644 --- a/functions/_libp2p_crypto.keys.importKey.html +++ b/functions/_libp2p_crypto.keys.importKey.html @@ -1,3 +1,3 @@ importKey | libp2p

    Function importKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<PrivateKey<T>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keyStretcher.html b/functions/_libp2p_crypto.keys.keyStretcher.html index 1410f5fd48..b37aaf21b3 100644 --- a/functions/_libp2p_crypto.keys.keyStretcher.html +++ b/functions/_libp2p_crypto.keys.keyStretcher.html @@ -1,3 +1,3 @@ keyStretcher | libp2p

    Function keyStretcher

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<EnhancedKeyPair>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.KeyType.codec.html b/functions/_libp2p_crypto.keys.keysPBM.KeyType.codec.html index a6ae770330..f74b8dd333 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.KeyType.codec.html +++ b/functions/_libp2p_crypto.keys.keysPBM.KeyType.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.codec.html b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.codec.html index 1da2d40522..6ff48a1bbb 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.codec.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.decode.html b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.decode.html index fe73a51388..8667ec2bf3 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.decode.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.decode.html @@ -1 +1 @@ -decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.encode.html b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.encode.html index ebf9c64f6d..da42fa81a6 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.encode.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.encode.html @@ -1 +1 @@ -encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.codec.html b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.codec.html index 93244028b4..fc9e421b75 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.codec.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.decode.html b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.decode.html index aafc631412..966b637fbc 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.decode.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.decode.html @@ -1 +1 @@ -decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +decode | libp2p

    Function decode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.encode.html b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.encode.html index 450aebef7f..80c7f1844d 100644 --- a/functions/_libp2p_crypto.keys.keysPBM.PublicKey.encode.html +++ b/functions/_libp2p_crypto.keys.keysPBM.PublicKey.encode.html @@ -1 +1 @@ -encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +encode | libp2p

    Function encode

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.marshalPrivateKey.html b/functions/_libp2p_crypto.keys.marshalPrivateKey.html index d2ad31befd..f005e7f14a 100644 --- a/functions/_libp2p_crypto.keys.marshalPrivateKey.html +++ b/functions/_libp2p_crypto.keys.marshalPrivateKey.html @@ -1,2 +1,2 @@ marshalPrivateKey | libp2p

    Function marshalPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.marshalPublicKey.html b/functions/_libp2p_crypto.keys.marshalPublicKey.html index 57fdd3ab50..3a8a3cd648 100644 --- a/functions/_libp2p_crypto.keys.marshalPublicKey.html +++ b/functions/_libp2p_crypto.keys.marshalPublicKey.html @@ -1,2 +1,2 @@ marshalPublicKey | libp2p

    Function marshalPublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html b/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html index b002a46210..166031fd05 100644 --- a/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html +++ b/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html @@ -1,2 +1,2 @@ unmarshalPrivateKey | libp2p

    Function unmarshalPrivateKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<PrivateKey<T>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_crypto.keys.unmarshalPublicKey.html b/functions/_libp2p_crypto.keys.unmarshalPublicKey.html index 21cfc3776f..f2456788ad 100644 --- a/functions/_libp2p_crypto.keys.unmarshalPublicKey.html +++ b/functions/_libp2p_crypto.keys.unmarshalPublicKey.html @@ -1,2 +1,2 @@ unmarshalPublicKey | libp2p

    Function unmarshalPublicKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns PublicKey<T>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_dcutr.dcutr.html b/functions/_libp2p_dcutr.dcutr.html index 4864d8b609..662f53b45d 100644 --- a/functions/_libp2p_dcutr.dcutr.html +++ b/functions/_libp2p_dcutr.dcutr.html @@ -1 +1 @@ -dcutr | libp2p

    Function dcutr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dcutr | libp2p

    Function dcutr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_devtools_metrics.devToolsMetrics.html b/functions/_libp2p_devtools_metrics.devToolsMetrics.html index 57ee0822f8..fbf6584141 100644 --- a/functions/_libp2p_devtools_metrics.devToolsMetrics.html +++ b/functions/_libp2p_devtools_metrics.devToolsMetrics.html @@ -1 +1 @@ -devToolsMetrics | libp2p

    Function devToolsMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +devToolsMetrics | libp2p

    Function devToolsMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_echo.echo-1.html b/functions/_libp2p_echo.echo-1.html index fb629878cb..520a1dc3d3 100644 --- a/functions/_libp2p_echo.echo-1.html +++ b/functions/_libp2p_echo.echo-1.html @@ -1 +1 @@ -echo | libp2p

    Function echo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +echo | libp2p

    Function echo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_fetch.fetch-1.html b/functions/_libp2p_fetch.fetch-1.html index a9f87a550e..1e4947c8d4 100644 --- a/functions/_libp2p_fetch.fetch-1.html +++ b/functions/_libp2p_fetch.fetch-1.html @@ -1 +1 @@ -fetch | libp2p

    Function fetch

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +fetch | libp2p

    Function fetch

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_floodsub.floodsub-1.html b/functions/_libp2p_floodsub.floodsub-1.html index ee02d84f28..50b34f7f6e 100644 --- a/functions/_libp2p_floodsub.floodsub-1.html +++ b/functions/_libp2p_floodsub.floodsub-1.html @@ -1 +1 @@ -floodsub | libp2p

    Function floodsub

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +floodsub | libp2p

    Function floodsub

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_identify.identify-1.html b/functions/_libp2p_identify.identify-1.html index 2b3f6139cf..368de15bd7 100644 --- a/functions/_libp2p_identify.identify-1.html +++ b/functions/_libp2p_identify.identify-1.html @@ -1 +1 @@ -identify | libp2p

    Function identify

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +identify | libp2p

    Function identify

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_identify.identifyPush-1.html b/functions/_libp2p_identify.identifyPush-1.html index 5a25c04eb1..1116758baf 100644 --- a/functions/_libp2p_identify.identifyPush-1.html +++ b/functions/_libp2p_identify.identifyPush-1.html @@ -1 +1 @@ -identifyPush | libp2p

    Function identifyPush

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +identifyPush | libp2p

    Function identifyPush

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isConnection.html b/functions/_libp2p_interface.isConnection.html index 6e4f715e94..b899fd1f8a 100644 --- a/functions/_libp2p_interface.isConnection.html +++ b/functions/_libp2p_interface.isConnection.html @@ -1 +1 @@ -isConnection | libp2p

    Function isConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isConnection | libp2p

    Function isConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isPeerId.html b/functions/_libp2p_interface.isPeerId.html index b46ed8d5c2..13ca8dbd3b 100644 --- a/functions/_libp2p_interface.isPeerId.html +++ b/functions/_libp2p_interface.isPeerId.html @@ -1 +1 @@ -isPeerId | libp2p

    Function isPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isPeerId | libp2p

    Function isPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isStartable.html b/functions/_libp2p_interface.isStartable.html index b1652864b6..20689fba41 100644 --- a/functions/_libp2p_interface.isStartable.html +++ b/functions/_libp2p_interface.isStartable.html @@ -1 +1 @@ -isStartable | libp2p

    Function isStartable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isStartable | libp2p

    Function isStartable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.isTransport.html b/functions/_libp2p_interface.isTransport.html index f61abae51b..57e517d3ce 100644 --- a/functions/_libp2p_interface.isTransport.html +++ b/functions/_libp2p_interface.isTransport.html @@ -1 +1 @@ -isTransport | libp2p

    Function isTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isTransport | libp2p

    Function isTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.setMaxListeners.html b/functions/_libp2p_interface.setMaxListeners.html index ed19ef556b..22eb12bc4f 100644 --- a/functions/_libp2p_interface.setMaxListeners.html +++ b/functions/_libp2p_interface.setMaxListeners.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Since

    v15.4.0

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.start.html b/functions/_libp2p_interface.start.html index 2bf60f9267..6ee45dd9ba 100644 --- a/functions/_libp2p_interface.start.html +++ b/functions/_libp2p_interface.start.html @@ -1 +1 @@ -start | libp2p

    Function start

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +start | libp2p

    Function start

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface.stop.html b/functions/_libp2p_interface.stop.html index b4b4619094..0712ec2e0f 100644 --- a/functions/_libp2p_interface.stop.html +++ b/functions/_libp2p_interface.stop.html @@ -1 +1 @@ -stop | libp2p

    Function stop

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +stop | libp2p

    Function stop

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.connection.default.html b/functions/_libp2p_interface_compliance_tests.connection.default.html index dd34bb7e35..f68bfd7c62 100644 --- a/functions/_libp2p_interface_compliance_tests.connection.default.html +++ b/functions/_libp2p_interface_compliance_tests.connection.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html b/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html index 9958986e47..44d506f627 100644 --- a/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html +++ b/functions/_libp2p_interface_compliance_tests.connection_encryption.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html b/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html index f96623cd1f..74d3d47e5f 100644 --- a/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html +++ b/functions/_libp2p_interface_compliance_tests.is_valid_tick.isValidTick.html @@ -1,3 +1,3 @@ isValidTick | libp2p

    Function isValidTick

    • isValidTick(date?, ms?): boolean

    • A tick is considered valid if it happened between now and ms milliseconds ago

      -

      Parameters

      • Optional date: number
      • ms: number = 5000

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html b/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html index 4cae10c749..bbc856f487 100644 --- a/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html +++ b/functions/_libp2p_interface_compliance_tests.matchers.matchMultiaddr.html @@ -1 +1 @@ -matchMultiaddr | libp2p

    Function matchMultiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +matchMultiaddr | libp2p

    Function matchMultiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html b/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html index df1d4e0402..cbc2501b22 100644 --- a/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html +++ b/functions/_libp2p_interface_compliance_tests.matchers.matchPeerId.html @@ -1 +1 @@ -matchPeerId | libp2p

    Function matchPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +matchPeerId | libp2p

    Function matchPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html b/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html index eb10bef593..545ebd0466 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.connectionPair.html @@ -1 +1 @@ -connectionPair | libp2p

    Function connectionPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +connectionPair | libp2p

    Function connectionPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html b/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html index 39ed8551da..261fb08919 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockConnection.html @@ -1 +1 @@ -mockConnection | libp2p

    Function mockConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockConnection | libp2p

    Function mockConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionGater.html b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionGater.html index 4c1a745d77..bb3a45d322 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionGater.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionGater.html @@ -1 +1 @@ -mockConnectionGater | libp2p

    Function mockConnectionGater

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockConnectionGater | libp2p

    Function mockConnectionGater

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html index 3401ecd946..8c4ec5cad6 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockConnectionManager.html @@ -1 +1 @@ -mockConnectionManager | libp2p

    Function mockConnectionManager

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockConnectionManager | libp2p

    Function mockConnectionManager

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html b/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html index cc7b975426..21bdd2ba14 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockDuplex.html @@ -1 +1 @@ -mockDuplex | libp2p

    Function mockDuplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockDuplex | libp2p

    Function mockDuplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMetrics.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMetrics.html index 730f119bab..5ae62aa556 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMetrics.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMetrics.html @@ -1 +1 @@ -mockMetrics | libp2p

    Function mockMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockMetrics | libp2p

    Function mockMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html index a3b0578db5..aeccfaaaa5 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnPair.html @@ -1,2 +1,2 @@ mockMultiaddrConnPair | libp2p

    Function mockMultiaddrConnPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns {
        inbound: MultiaddrConnection;
        outbound: MultiaddrConnection;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html index 02c4fc93da..0d76b8bfde 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMultiaddrConnection.html @@ -1 +1 @@ -mockMultiaddrConnection | libp2p

    Function mockMultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockMultiaddrConnection | libp2p

    Function mockMultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html b/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html index e0be425136..09a1e1ce56 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockMuxer.html @@ -1 +1 @@ -mockMuxer | libp2p

    Function mockMuxer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockMuxer | libp2p

    Function mockMuxer

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html b/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html index e388bdf666..09e5e67c88 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockRegistrar.html @@ -1 +1 @@ -mockRegistrar | libp2p

    Function mockRegistrar

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockRegistrar | libp2p

    Function mockRegistrar

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html b/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html index 0c91e8b3b9..703c92dc8b 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockStream.html @@ -1 +1 @@ -mockStream | libp2p

    Function mockStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockStream | libp2p

    Function mockStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html b/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html index 52ec2b7f4c..1c272cb5e0 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.mockUpgrader.html @@ -1 +1 @@ -mockUpgrader | libp2p

    Function mockUpgrader

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mockUpgrader | libp2p

    Function mockUpgrader

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html b/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html index 5eaf974c9a..ec37c0c21a 100644 --- a/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html +++ b/functions/_libp2p_interface_compliance_tests.mocks.streamPair.html @@ -1 +1 @@ -streamPair | libp2p

    Function streamPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +streamPair | libp2p

    Function streamPair

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html b/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html index 5f6e100c47..350b392ea7 100644 --- a/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html +++ b/functions/_libp2p_interface_compliance_tests.peer_discovery.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.pubsub.default.html b/functions/_libp2p_interface_compliance_tests.pubsub.default.html index bf846699d9..6bd7b86306 100644 --- a/functions/_libp2p_interface_compliance_tests.pubsub.default.html +++ b/functions/_libp2p_interface_compliance_tests.pubsub.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html b/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html index f57cd8d1ed..291f3d8b0d 100644 --- a/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html +++ b/functions/_libp2p_interface_compliance_tests.stream_muxer.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_interface_compliance_tests.transport.default.html b/functions/_libp2p_interface_compliance_tests.transport.default.html index bf502b8b09..ce4f1f136c 100644 --- a/functions/_libp2p_interface_compliance_tests.transport.default.html +++ b/functions/_libp2p_interface_compliance_tests.transport.default.html @@ -1 +1 @@ -default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +default | libp2p

    Function default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.MessageType.codec.html b/functions/_libp2p_kad_dht.MessageType.codec.html index edd51f0fe1..8a2094f516 100644 --- a/functions/_libp2p_kad_dht.MessageType.codec.html +++ b/functions/_libp2p_kad_dht.MessageType.codec.html @@ -1 +1 @@ -codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +codec | libp2p

    Function codec

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.kadDHT-1.html b/functions/_libp2p_kad_dht.kadDHT-1.html index 627f37e78b..a87b775b9f 100644 --- a/functions/_libp2p_kad_dht.kadDHT-1.html +++ b/functions/_libp2p_kad_dht.kadDHT-1.html @@ -1,3 +1,3 @@ kadDHT | libp2p

    Function kadDHT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns ((components) => KadDHT)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.passthroughMapper.html b/functions/_libp2p_kad_dht.passthroughMapper.html index 1be660ab8c..5def909286 100644 --- a/functions/_libp2p_kad_dht.passthroughMapper.html +++ b/functions/_libp2p_kad_dht.passthroughMapper.html @@ -1 +1 @@ -passthroughMapper | libp2p

    Function passthroughMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +passthroughMapper | libp2p

    Function passthroughMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html b/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html index 1a6eeea791..87a45d1d5c 100644 --- a/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html +++ b/functions/_libp2p_kad_dht.removePrivateAddressesMapper.html @@ -1 +1 @@ -removePrivateAddressesMapper | libp2p

    Function removePrivateAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +removePrivateAddressesMapper | libp2p

    Function removePrivateAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_kad_dht.removePublicAddressesMapper.html b/functions/_libp2p_kad_dht.removePublicAddressesMapper.html index 043dfed4c2..9435166f51 100644 --- a/functions/_libp2p_kad_dht.removePublicAddressesMapper.html +++ b/functions/_libp2p_kad_dht.removePublicAddressesMapper.html @@ -1 +1 @@ -removePublicAddressesMapper | libp2p

    Function removePublicAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +removePublicAddressesMapper | libp2p

    Function removePublicAddressesMapper

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_keychain.keychain-1.html b/functions/_libp2p_keychain.keychain-1.html index 4fdfcfd698..44559aef16 100644 --- a/functions/_libp2p_keychain.keychain-1.html +++ b/functions/_libp2p_keychain.keychain-1.html @@ -1 +1 @@ -keychain | libp2p

    Function keychain

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +keychain | libp2p

    Function keychain

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.defaultLogger.html b/functions/_libp2p_logger.defaultLogger.html index 5e685e9a54..11ff05d09a 100644 --- a/functions/_libp2p_logger.defaultLogger.html +++ b/functions/_libp2p_logger.defaultLogger.html @@ -1,4 +1,4 @@ defaultLogger | libp2p

    Function defaultLogger

    • defaultLogger(): ComponentLogger

    • Create a component logger

      Returns ComponentLogger

      Example

      import { defaultLogger } from '@libp2p/logger'
      import { peerIdFromString } from '@libp2p/peer-id'

      const logger = defaultLogger()

      const log = logger.forComponent('my-component')
      log.info('hello world')
      // logs "my-component hello world"
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.disable.html b/functions/_libp2p_logger.disable.html index c0fcef22c8..6aad86b56a 100644 --- a/functions/_libp2p_logger.disable.html +++ b/functions/_libp2p_logger.disable.html @@ -1 +1 @@ -disable | libp2p

    Function disable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +disable | libp2p

    Function disable

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.enable.html b/functions/_libp2p_logger.enable.html index d5ea01ac2c..1d856c041e 100644 --- a/functions/_libp2p_logger.enable.html +++ b/functions/_libp2p_logger.enable.html @@ -1 +1 @@ -enable | libp2p

    Function enable

    • enable(namespaces): void

    • Parameters

      • namespaces: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +enable | libp2p

    Function enable

    • enable(namespaces): void

    • Parameters

      • namespaces: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.enabled.html b/functions/_libp2p_logger.enabled.html index 55fd714aff..bde78ff81f 100644 --- a/functions/_libp2p_logger.enabled.html +++ b/functions/_libp2p_logger.enabled.html @@ -1 +1 @@ -enabled | libp2p

    Function enabled

    • enabled(namespaces): boolean

    • Parameters

      • namespaces: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +enabled | libp2p

    Function enabled

    • enabled(namespaces): boolean

    • Parameters

      • namespaces: string

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.logger-1.html b/functions/_libp2p_logger.logger-1.html index 3c5ed19a9f..e6e7ed3bc1 100644 --- a/functions/_libp2p_logger.logger-1.html +++ b/functions/_libp2p_logger.logger-1.html @@ -1,4 +1,4 @@ logger | libp2p

    Function logger

    • logger(name): Logger

    • Creates a logger for the passed component name.

      Parameters

      • name: string

      Returns Logger

      Example

      import { logger } from '@libp2p/logger'

      const log = logger('my-component')
      log.info('hello world')
      // logs "my-component hello world"
      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.peerLogger.html b/functions/_libp2p_logger.peerLogger.html index 4accb5c6d2..6afb69d3bc 100644 --- a/functions/_libp2p_logger.peerLogger.html +++ b/functions/_libp2p_logger.peerLogger.html @@ -2,4 +2,4 @@ peer id.

    Parameters

    Returns ComponentLogger

    Example

    import { peerLogger } from '@libp2p/logger'
    import { peerIdFromString } from '@libp2p/peer-id'

    const peerId = peerIdFromString('12D3FooBar')
    const logger = peerLogger(peerId)

    const log = logger.forComponent('my-component')
    log.info('hello world')
    // logs "12…oBar:my-component hello world"
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_logger.prefixLogger.html b/functions/_libp2p_logger.prefixLogger.html index 10664d9b61..ed5db45ff0 100644 --- a/functions/_libp2p_logger.prefixLogger.html +++ b/functions/_libp2p_logger.prefixLogger.html @@ -2,4 +2,4 @@ string.

    Parameters

    Returns ComponentLogger

    Example

    import { prefixLogger } from '@libp2p/logger'

    const logger = prefixLogger('my-node')

    const log = logger.forComponent('my-component')
    log.info('hello world')
    // logs "my-node:my-component hello world"
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_mdns.mdns.html b/functions/_libp2p_mdns.mdns.html index 595974f798..67cef42415 100644 --- a/functions/_libp2p_mdns.mdns.html +++ b/functions/_libp2p_mdns.mdns.html @@ -1 +1 @@ -mdns | libp2p

    Function mdns

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mdns | libp2p

    Function mdns

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_mplex.mplex.html b/functions/_libp2p_mplex.mplex.html index 0af1eb2ea5..9af2e8f2e6 100644 --- a/functions/_libp2p_mplex.mplex.html +++ b/functions/_libp2p_mplex.mplex.html @@ -1 +1 @@ -mplex | libp2p

    Function mplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +mplex | libp2p

    Function mplex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_multistream_select.handle.html b/functions/_libp2p_multistream_select.handle.html index 68910bc5bf..01fa76db4c 100644 --- a/functions/_libp2p_multistream_select.handle.html +++ b/functions/_libp2p_multistream_select.handle.html @@ -6,4 +6,4 @@

    Returns Promise<ProtocolStream<Stream>>

    A stream for the selected protocol and the protocol that was selected from the list of protocols provided to select

    Example

    import { pipe } from 'it-pipe'
    import * as mss from '@libp2p/multistream-select'
    import { Mplex } from '@libp2p/mplex'

    const muxer = new Mplex({
      async onStream (muxedStream) {
      // mss.handle(handledProtocols)
      // Returns selected stream and protocol
      const { stream, protocol } = await mss.handle(muxedStream, [
        '/ipfs-dht/1.0.0',
        '/ipfs-bitswap/1.0.0'
      ])

      // Typically here we'd call the handler function that was registered in
      // libp2p for the given protocol:
      // e.g. handlers[protocol].handler(stream)
      //
      // If protocol was /ipfs-dht/1.0.0 it might do something like this:
      // try {
      //   await pipe(
      //     dhtStream,
      //     source => (async function * () {
      //       for await (const chunk of source)
      //         // Incoming DHT data -> process and yield to respond
      //     })(),
      //     dhtStream
      //   )
      // } catch (err) {
      //   // Error in stream
      // }
      }
    })
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_multistream_select.select.html b/functions/_libp2p_multistream_select.select.html index b7f3a50af6..ae70a5f4a5 100644 --- a/functions/_libp2p_multistream_select.select.html +++ b/functions/_libp2p_multistream_select.select.html @@ -5,4 +5,4 @@

    Returns Promise<ProtocolStream<Stream>>

    A stream for the selected protocol and the protocol that was selected from the list of protocols provided to select.

    Example

    import { pipe } from 'it-pipe'
    import * as mss from '@libp2p/multistream-select'
    import { Mplex } from '@libp2p/mplex'

    const muxer = new Mplex()
    const muxedStream = muxer.newStream()

    // mss.select(protocol(s))
    // Select from one of the passed protocols (in priority order)
    // Returns selected stream and protocol
    const { stream: dhtStream, protocol } = await mss.select(muxedStream, [
      // This might just be different versions of DHT, but could be different impls
      '/ipfs-dht/2.0.0', // Most of the time this will probably just be one item.
      '/ipfs-dht/1.0.0'
    ])

    // Typically this stream will be passed back to the caller of libp2p.dialProtocol
    //
    // ...it might then do something like this:
    // try {
    //   await pipe(
    //     [uint8ArrayFromString('Some DHT data')]
    //     dhtStream,
    //     async source => {
    //       for await (const chunk of source)
    //         // DHT response data
    //     }
    //   )
    // } catch (err) {
    //   // Error in stream
    // }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerFilter-1.html b/functions/_libp2p_peer_collections.peerFilter-1.html index af0cdf4478..6becd1adf8 100644 --- a/functions/_libp2p_peer_collections.peerFilter-1.html +++ b/functions/_libp2p_peer_collections.peerFilter-1.html @@ -1,4 +1,4 @@ peerFilter | libp2p

    Function peerFilter

    • peerFilter(size, errorRate?): PeerFilter

    • Create and return a PeerFilter

      Parameters

      • size: number

        The maximum number of peers expected to be added to the filter

      • errorRate: number = 0.001

        The acceptable error rate

        -

      Returns PeerFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns PeerFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerList-1.html b/functions/_libp2p_peer_collections.peerList-1.html index da23894404..7802d292a1 100644 --- a/functions/_libp2p_peer_collections.peerList-1.html +++ b/functions/_libp2p_peer_collections.peerList-1.html @@ -1 +1 @@ -peerList | libp2p

    Function peerList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerList | libp2p

    Function peerList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerMap-1.html b/functions/_libp2p_peer_collections.peerMap-1.html index cf05cba50c..244fdcfb52 100644 --- a/functions/_libp2p_peer_collections.peerMap-1.html +++ b/functions/_libp2p_peer_collections.peerMap-1.html @@ -1 +1 @@ -peerMap | libp2p

    Function peerMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerMap | libp2p

    Function peerMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.peerSet-1.html b/functions/_libp2p_peer_collections.peerSet-1.html index 341d72e046..ab5b7119c3 100644 --- a/functions/_libp2p_peer_collections.peerSet-1.html +++ b/functions/_libp2p_peer_collections.peerSet-1.html @@ -1 +1 @@ -peerSet | libp2p

    Function peerSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerSet | libp2p

    Function peerSet

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerList.html b/functions/_libp2p_peer_collections.trackedPeerList.html index 5d09fe6f0b..90ed5941ab 100644 --- a/functions/_libp2p_peer_collections.trackedPeerList.html +++ b/functions/_libp2p_peer_collections.trackedPeerList.html @@ -10,4 +10,4 @@

    const list = trackedPeerList({ name: 'my_metric_name', metrics: libp2p.metrics }) list.push(peerId) ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerMap.html b/functions/_libp2p_peer_collections.trackedPeerMap.html index 8ffbf67602..a3fb8cbac9 100644 --- a/functions/_libp2p_peer_collections.trackedPeerMap.html +++ b/functions/_libp2p_peer_collections.trackedPeerMap.html @@ -10,4 +10,4 @@

    const list = trackedPeerMap({ name: 'my_metric_name', metrics: libp2p.metrics }) map.set(peerId, 'value') ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_collections.trackedPeerSet.html b/functions/_libp2p_peer_collections.trackedPeerSet.html index 5c036abd6c..01b42df63c 100644 --- a/functions/_libp2p_peer_collections.trackedPeerSet.html +++ b/functions/_libp2p_peer_collections.trackedPeerSet.html @@ -10,4 +10,4 @@

    const list = trackedPeerSet({ name: 'my_metric_name', metrics: libp2p.metrics }) map.add(peerId) ```

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.createPeerId.html b/functions/_libp2p_peer_id.createPeerId.html index 3283a8f69b..93df2211a8 100644 --- a/functions/_libp2p_peer_id.createPeerId.html +++ b/functions/_libp2p_peer_id.createPeerId.html @@ -1 +1 @@ -createPeerId | libp2p

    Function createPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createPeerId | libp2p

    Function createPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromBytes.html b/functions/_libp2p_peer_id.peerIdFromBytes.html index 24d18eb90c..e9e6492ea9 100644 --- a/functions/_libp2p_peer_id.peerIdFromBytes.html +++ b/functions/_libp2p_peer_id.peerIdFromBytes.html @@ -1 +1 @@ -peerIdFromBytes | libp2p

    Function peerIdFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromBytes | libp2p

    Function peerIdFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromCID.html b/functions/_libp2p_peer_id.peerIdFromCID.html index 4932b20ef9..3fed32046c 100644 --- a/functions/_libp2p_peer_id.peerIdFromCID.html +++ b/functions/_libp2p_peer_id.peerIdFromCID.html @@ -1 +1 @@ -peerIdFromCID | libp2p

    Function peerIdFromCID

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromCID | libp2p

    Function peerIdFromCID

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromKeys.html b/functions/_libp2p_peer_id.peerIdFromKeys.html index 27b60e5675..b6ba7a2bfd 100644 --- a/functions/_libp2p_peer_id.peerIdFromKeys.html +++ b/functions/_libp2p_peer_id.peerIdFromKeys.html @@ -1,3 +1,3 @@ peerIdFromKeys | libp2p

    Function peerIdFromKeys

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<Ed25519PeerId | Secp256k1PeerId | RSAPeerId>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromPeerId.html b/functions/_libp2p_peer_id.peerIdFromPeerId.html index c3f7aa05bc..2c1f58dcbb 100644 --- a/functions/_libp2p_peer_id.peerIdFromPeerId.html +++ b/functions/_libp2p_peer_id.peerIdFromPeerId.html @@ -1 +1 @@ -peerIdFromPeerId | libp2p

    Function peerIdFromPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromPeerId | libp2p

    Function peerIdFromPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id.peerIdFromString.html b/functions/_libp2p_peer_id.peerIdFromString.html index 14c33db617..129063f4f8 100644 --- a/functions/_libp2p_peer_id.peerIdFromString.html +++ b/functions/_libp2p_peer_id.peerIdFromString.html @@ -1 +1 @@ -peerIdFromString | libp2p

    Function peerIdFromString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +peerIdFromString | libp2p

    Function peerIdFromString

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createEd25519PeerId.html b/functions/_libp2p_peer_id_factory.createEd25519PeerId.html index 893949946d..b3f1295103 100644 --- a/functions/_libp2p_peer_id_factory.createEd25519PeerId.html +++ b/functions/_libp2p_peer_id_factory.createEd25519PeerId.html @@ -1 +1 @@ -createEd25519PeerId | libp2p

    Function createEd25519PeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createEd25519PeerId | libp2p

    Function createEd25519PeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createFromJSON.html b/functions/_libp2p_peer_id_factory.createFromJSON.html index 34e7110fbc..0fc8ce171b 100644 --- a/functions/_libp2p_peer_id_factory.createFromJSON.html +++ b/functions/_libp2p_peer_id_factory.createFromJSON.html @@ -1 +1 @@ -createFromJSON | libp2p

    Function createFromJSON

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createFromJSON | libp2p

    Function createFromJSON

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createFromPrivKey.html b/functions/_libp2p_peer_id_factory.createFromPrivKey.html index 7f0bee2972..d6cee175f4 100644 --- a/functions/_libp2p_peer_id_factory.createFromPrivKey.html +++ b/functions/_libp2p_peer_id_factory.createFromPrivKey.html @@ -1 +1 @@ -createFromPrivKey | libp2p

    Function createFromPrivKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createFromPrivKey | libp2p

    Function createFromPrivKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createFromProtobuf.html b/functions/_libp2p_peer_id_factory.createFromProtobuf.html index 385b97552e..a38d2ea33b 100644 --- a/functions/_libp2p_peer_id_factory.createFromProtobuf.html +++ b/functions/_libp2p_peer_id_factory.createFromProtobuf.html @@ -1 +1 @@ -createFromProtobuf | libp2p

    Function createFromProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createFromProtobuf | libp2p

    Function createFromProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createFromPubKey.html b/functions/_libp2p_peer_id_factory.createFromPubKey.html index c159cef7af..3e209e4a27 100644 --- a/functions/_libp2p_peer_id_factory.createFromPubKey.html +++ b/functions/_libp2p_peer_id_factory.createFromPubKey.html @@ -1 +1 @@ -createFromPubKey | libp2p

    Function createFromPubKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createFromPubKey | libp2p

    Function createFromPubKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createRSAPeerId.html b/functions/_libp2p_peer_id_factory.createRSAPeerId.html index 0bb78d2f98..2cd169ef68 100644 --- a/functions/_libp2p_peer_id_factory.createRSAPeerId.html +++ b/functions/_libp2p_peer_id_factory.createRSAPeerId.html @@ -1 +1 @@ -createRSAPeerId | libp2p

    Function createRSAPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createRSAPeerId | libp2p

    Function createRSAPeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.createSecp256k1PeerId.html b/functions/_libp2p_peer_id_factory.createSecp256k1PeerId.html index e8db598a72..0852e83cf7 100644 --- a/functions/_libp2p_peer_id_factory.createSecp256k1PeerId.html +++ b/functions/_libp2p_peer_id_factory.createSecp256k1PeerId.html @@ -1 +1 @@ -createSecp256k1PeerId | libp2p

    Function createSecp256k1PeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createSecp256k1PeerId | libp2p

    Function createSecp256k1PeerId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_peer_id_factory.exportToProtobuf.html b/functions/_libp2p_peer_id_factory.exportToProtobuf.html index 9cc6733b6c..0b13c05594 100644 --- a/functions/_libp2p_peer_id_factory.exportToProtobuf.html +++ b/functions/_libp2p_peer_id_factory.exportToProtobuf.html @@ -1 +1 @@ -exportToProtobuf | libp2p

    Function exportToProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +exportToProtobuf | libp2p

    Function exportToProtobuf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_perf.perf-1.html b/functions/_libp2p_perf.perf-1.html index 306ab1917b..3414774d4b 100644 --- a/functions/_libp2p_perf.perf-1.html +++ b/functions/_libp2p_perf.perf-1.html @@ -1 +1 @@ -perf | libp2p

    Function perf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +perf | libp2p

    Function perf

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_ping.ping.html b/functions/_libp2p_ping.ping.html index 7df89ba668..e86e6e6cb9 100644 --- a/functions/_libp2p_ping.ping.html +++ b/functions/_libp2p_ping.ping.html @@ -1 +1 @@ -ping | libp2p

    Function ping

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ping | libp2p

    Function ping

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_plaintext.plaintext.html b/functions/_libp2p_plaintext.plaintext.html index 443196c33b..24b8af6818 100644 --- a/functions/_libp2p_plaintext.plaintext.html +++ b/functions/_libp2p_plaintext.plaintext.html @@ -1 +1 @@ -plaintext | libp2p

    Function plaintext

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +plaintext | libp2p

    Function plaintext

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pnet.generateKey.html b/functions/_libp2p_pnet.generateKey.html index 50c612847f..087fc6137a 100644 --- a/functions/_libp2p_pnet.generateKey.html +++ b/functions/_libp2p_pnet.generateKey.html @@ -1,3 +1,3 @@ generateKey | libp2p

    Function generateKey

    • generateKey(bytes): void

    • Generates a PSK that can be used in a libp2p-pnet private network

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pnet.preSharedKey.html b/functions/_libp2p_pnet.preSharedKey.html index ddd1c6b4ea..4a5023c0d7 100644 --- a/functions/_libp2p_pnet.preSharedKey.html +++ b/functions/_libp2p_pnet.preSharedKey.html @@ -1 +1 @@ -preSharedKey | libp2p

    Function preSharedKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +preSharedKey | libp2p

    Function preSharedKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_prometheus_metrics.prometheusMetrics.html b/functions/_libp2p_prometheus_metrics.prometheusMetrics.html index 02c5ea2fd5..e3b89c72a8 100644 --- a/functions/_libp2p_prometheus_metrics.prometheusMetrics.html +++ b/functions/_libp2p_prometheus_metrics.prometheusMetrics.html @@ -1 +1 @@ -prometheusMetrics | libp2p

    Function prometheusMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +prometheusMetrics | libp2p

    Function prometheusMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.anyMatch.html b/functions/_libp2p_pubsub.utils.anyMatch.html index 5de620d48f..756277deef 100644 --- a/functions/_libp2p_pubsub.utils.anyMatch.html +++ b/functions/_libp2p_pubsub.utils.anyMatch.html @@ -1,3 +1,3 @@ anyMatch | libp2p

    Function anyMatch

    • anyMatch(a, b): boolean

    • Check if any member of the first set is also a member of the second set

      -

      Parameters

      • a: Set<number> | number[]
      • b: Set<number> | number[]

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.bigIntFromBytes.html b/functions/_libp2p_pubsub.utils.bigIntFromBytes.html index b5cde36dfc..b532e1362e 100644 --- a/functions/_libp2p_pubsub.utils.bigIntFromBytes.html +++ b/functions/_libp2p_pubsub.utils.bigIntFromBytes.html @@ -1 +1 @@ -bigIntFromBytes | libp2p

    Function bigIntFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bigIntFromBytes | libp2p

    Function bigIntFromBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.bigIntToBytes.html b/functions/_libp2p_pubsub.utils.bigIntToBytes.html index 6af663773d..be1a9c7294 100644 --- a/functions/_libp2p_pubsub.utils.bigIntToBytes.html +++ b/functions/_libp2p_pubsub.utils.bigIntToBytes.html @@ -1 +1 @@ -bigIntToBytes | libp2p

    Function bigIntToBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +bigIntToBytes | libp2p

    Function bigIntToBytes

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.ensureArray.html b/functions/_libp2p_pubsub.utils.ensureArray.html index 804dc73781..2b839e98c2 100644 --- a/functions/_libp2p_pubsub.utils.ensureArray.html +++ b/functions/_libp2p_pubsub.utils.ensureArray.html @@ -1,2 +1,2 @@ ensureArray | libp2p

    Function ensureArray

    • ensureArray<T>(maybeArray): T[]

    • Make everything an array

      -

      Type Parameters

      • T

      Parameters

      • maybeArray: T | T[]

      Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.msgId.html b/functions/_libp2p_pubsub.utils.msgId.html index 62c70be496..f62f995611 100644 --- a/functions/_libp2p_pubsub.utils.msgId.html +++ b/functions/_libp2p_pubsub.utils.msgId.html @@ -1,2 +1,2 @@ msgId | libp2p

    Function msgId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.noSignMsgId.html b/functions/_libp2p_pubsub.utils.noSignMsgId.html index 5e618bf0d1..d229e6be63 100644 --- a/functions/_libp2p_pubsub.utils.noSignMsgId.html +++ b/functions/_libp2p_pubsub.utils.noSignMsgId.html @@ -1,2 +1,2 @@ noSignMsgId | libp2p

    Function noSignMsgId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Uint8Array | Promise<Uint8Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.randomSeqno.html b/functions/_libp2p_pubsub.utils.randomSeqno.html index 2fb4a51945..780b991606 100644 --- a/functions/_libp2p_pubsub.utils.randomSeqno.html +++ b/functions/_libp2p_pubsub.utils.randomSeqno.html @@ -1,2 +1,2 @@ randomSeqno | libp2p

    Function randomSeqno

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.toMessage.html b/functions/_libp2p_pubsub.utils.toMessage.html index c35953f2be..029e30708a 100644 --- a/functions/_libp2p_pubsub.utils.toMessage.html +++ b/functions/_libp2p_pubsub.utils.toMessage.html @@ -1 +1 @@ -toMessage | libp2p

    Function toMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +toMessage | libp2p

    Function toMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_pubsub.utils.toRpcMessage.html b/functions/_libp2p_pubsub.utils.toRpcMessage.html index e115b6e59b..5475546e0c 100644 --- a/functions/_libp2p_pubsub.utils.toRpcMessage.html +++ b/functions/_libp2p_pubsub.utils.toRpcMessage.html @@ -1 +1 @@ -toRpcMessage | libp2p

    Function toRpcMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +toRpcMessage | libp2p

    Function toRpcMessage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_simple_metrics.simpleMetrics.html b/functions/_libp2p_simple_metrics.simpleMetrics.html index 64ce6bd36c..9ce0649450 100644 --- a/functions/_libp2p_simple_metrics.simpleMetrics.html +++ b/functions/_libp2p_simple_metrics.simpleMetrics.html @@ -1 +1 @@ -simpleMetrics | libp2p

    Function simpleMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +simpleMetrics | libp2p

    Function simpleMetrics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_tcp.tcp.html b/functions/_libp2p_tcp.tcp.html index 2037b46276..d142eb64d9 100644 --- a/functions/_libp2p_tcp.tcp.html +++ b/functions/_libp2p_tcp.tcp.html @@ -1 +1 @@ -tcp | libp2p

    Function tcp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +tcp | libp2p

    Function tcp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_tls.tls.html b/functions/_libp2p_tls.tls.html index 0514bd0515..87670fcd57 100644 --- a/functions/_libp2p_tls.tls.html +++ b/functions/_libp2p_tls.tls.html @@ -1 +1 @@ -tls | libp2p

    Function tls

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +tls | libp2p

    Function tls

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_upnp_nat.uPnPNAT-1.html b/functions/_libp2p_upnp_nat.uPnPNAT-1.html index aaaa5bfcf6..b4795297dc 100644 --- a/functions/_libp2p_upnp_nat.uPnPNAT-1.html +++ b/functions/_libp2p_upnp_nat.uPnPNAT-1.html @@ -1 +1 @@ -uPnPNAT | libp2p

    Function uPnPNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +uPnPNAT | libp2p

    Function uPnPNAT

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.abort_options.createTimeoutOptions.html b/functions/_libp2p_utils.abort_options.createTimeoutOptions.html index 94a303e673..9c04f6c802 100644 --- a/functions/_libp2p_utils.abort_options.createTimeoutOptions.html +++ b/functions/_libp2p_utils.abort_options.createTimeoutOptions.html @@ -1 +1 @@ -createTimeoutOptions | libp2p

    Function createTimeoutOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createTimeoutOptions | libp2p

    Function createTimeoutOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html b/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html index 59b73513b3..b272c7bd94 100644 --- a/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html +++ b/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html @@ -1,3 +1,3 @@ certifiedAddressesFirst | libp2p

    Function certifiedAddressesFirst

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns -1 | 0 | 1

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html b/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html index c4c85e24e7..2dd4bdeb81 100644 --- a/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html +++ b/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html @@ -1,3 +1,3 @@ circuitRelayAddressesLast | libp2p

    Function circuitRelayAddressesLast

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns -1 | 0 | 1

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.address_sort.defaultAddressSort.html b/functions/_libp2p_utils.address_sort.defaultAddressSort.html index 564573e94c..c0958786f0 100644 --- a/functions/_libp2p_utils.address_sort.defaultAddressSort.html +++ b/functions/_libp2p_utils.address_sort.defaultAddressSort.html @@ -1 +1 @@ -defaultAddressSort | libp2p

    Function defaultAddressSort

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +defaultAddressSort | libp2p

    Function defaultAddressSort

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.address_sort.publicAddressesFirst.html b/functions/_libp2p_utils.address_sort.publicAddressesFirst.html index 4bac5dbb27..a30b449a2f 100644 --- a/functions/_libp2p_utils.address_sort.publicAddressesFirst.html +++ b/functions/_libp2p_utils.address_sort.publicAddressesFirst.html @@ -1,3 +1,3 @@ publicAddressesFirst | libp2p

    Function publicAddressesFirst

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns -1 | 0 | 1

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.array_equals.arrayEquals.html b/functions/_libp2p_utils.array_equals.arrayEquals.html index 9a6f4af9c4..06f8fcca8a 100644 --- a/functions/_libp2p_utils.array_equals.arrayEquals.html +++ b/functions/_libp2p_utils.array_equals.arrayEquals.html @@ -1,3 +1,3 @@ arrayEquals | libp2p

    Function arrayEquals

    • arrayEquals(a, b): boolean

    • Verify if two arrays of non primitive types with the "equals" function are equal. Compatible with multiaddr, peer-id and others.

      -

      Parameters

      • a: any[]
      • b: any[]

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html b/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html index d050397a4f..39cdc7f0d3 100644 --- a/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html +++ b/functions/_libp2p_utils.close.safelyCloseConnectionIfUnused.html @@ -1,3 +1,3 @@ safelyCloseConnectionIfUnused | libp2p

    Function safelyCloseConnectionIfUnused

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close.safelyCloseStream.html b/functions/_libp2p_utils.close.safelyCloseStream.html index 000d17a6ae..039586bcd0 100644 --- a/functions/_libp2p_utils.close.safelyCloseStream.html +++ b/functions/_libp2p_utils.close.safelyCloseStream.html @@ -1,3 +1,3 @@ safelyCloseStream | libp2p

    Function safelyCloseStream

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.close_source.closeSource.html b/functions/_libp2p_utils.close_source.closeSource.html index 4e553b42fc..314c48985c 100644 --- a/functions/_libp2p_utils.close_source.closeSource.html +++ b/functions/_libp2p_utils.close_source.closeSource.html @@ -1 +1 @@ -closeSource | libp2p

    Function closeSource

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +closeSource | libp2p

    Function closeSource

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createBloomFilter.html b/functions/_libp2p_utils.filters.createBloomFilter.html index 85f483c69e..dff2bc8a48 100644 --- a/functions/_libp2p_utils.filters.createBloomFilter.html +++ b/functions/_libp2p_utils.filters.createBloomFilter.html @@ -1,3 +1,3 @@ createBloomFilter | libp2p

    Function createBloomFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Filter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createCuckooFilter.html b/functions/_libp2p_utils.filters.createCuckooFilter.html index 39c111bd8c..3a93da6cd9 100644 --- a/functions/_libp2p_utils.filters.createCuckooFilter.html +++ b/functions/_libp2p_utils.filters.createCuckooFilter.html @@ -1 +1 @@ -createCuckooFilter | libp2p

    Function createCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createCuckooFilter | libp2p

    Function createCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.filters.createScalableCuckooFilter.html b/functions/_libp2p_utils.filters.createScalableCuckooFilter.html index 3e1cb7a5e4..458b8aa196 100644 --- a/functions/_libp2p_utils.filters.createScalableCuckooFilter.html +++ b/functions/_libp2p_utils.filters.createScalableCuckooFilter.html @@ -1 +1 @@ -createScalableCuckooFilter | libp2p

    Function createScalableCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createScalableCuckooFilter | libp2p

    Function createScalableCuckooFilter

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html b/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html index 93e7583a82..d31b3349ea 100644 --- a/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html +++ b/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html @@ -1,2 +1,2 @@ ipPortToMultiaddr | libp2p

    Function ipPortToMultiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Multiaddr

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.is_promise.isPromise.html b/functions/_libp2p_utils.is_promise.isPromise.html index d748d65c66..9d8bce8783 100644 --- a/functions/_libp2p_utils.is_promise.isPromise.html +++ b/functions/_libp2p_utils.is_promise.isPromise.html @@ -1 +1 @@ -isPromise | libp2p

    Function isPromise

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isPromise | libp2p

    Function isPromise

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html b/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html index 3d6e89825f..40fac6e36f 100644 --- a/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html +++ b/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html @@ -1,2 +1,2 @@ isLoopback | libp2p

    Function isLoopback

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html b/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html index 2d2b30c601..36a82f3294 100644 --- a/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html +++ b/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html @@ -1,2 +1,2 @@ isPrivate | libp2p

    Function isPrivate

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.private_ip.isPrivateIp.html b/functions/_libp2p_utils.private_ip.isPrivateIp.html index 3210725064..c128407137 100644 --- a/functions/_libp2p_utils.private_ip.isPrivateIp.html +++ b/functions/_libp2p_utils.private_ip.isPrivateIp.html @@ -1 +1 @@ -isPrivateIp | libp2p

    Function isPrivateIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +isPrivateIp | libp2p

    Function isPrivateIp

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html b/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html index 05a7b7b6ed..935082ba5e 100644 --- a/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html +++ b/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html @@ -1,3 +1,3 @@ streamToMaConnection | libp2p

    Function streamToMaConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns MultiaddrConnection

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.tracked_list.trackedList.html b/functions/_libp2p_utils.tracked_list.trackedList.html index a7349a059f..1fef0a736f 100644 --- a/functions/_libp2p_utils.tracked_list.trackedList.html +++ b/functions/_libp2p_utils.tracked_list.trackedList.html @@ -1 +1 @@ -trackedList | libp2p

    Function trackedList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +trackedList | libp2p

    Function trackedList

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_utils.tracked_map.trackedMap.html b/functions/_libp2p_utils.tracked_map.trackedMap.html index 7380b1cf97..8e01481c0a 100644 --- a/functions/_libp2p_utils.tracked_map.trackedMap.html +++ b/functions/_libp2p_utils.tracked_map.trackedMap.html @@ -1 +1 @@ -trackedMap | libp2p

    Function trackedMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +trackedMap | libp2p

    Function trackedMap

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webrtc.webRTC.html b/functions/_libp2p_webrtc.webRTC.html index 08a32b0383..a99c2e1d09 100644 --- a/functions/_libp2p_webrtc.webRTC.html +++ b/functions/_libp2p_webrtc.webRTC.html @@ -1,2 +1,2 @@ webRTC | libp2p

    Function webRTC

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns ((components) => Transport)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webrtc.webRTCDirect.html b/functions/_libp2p_webrtc.webRTCDirect.html index 352e04d148..f50d555214 100644 --- a/functions/_libp2p_webrtc.webRTCDirect.html +++ b/functions/_libp2p_webrtc.webRTCDirect.html @@ -1,2 +1,2 @@ webRTCDirect | libp2p

    Function webRTCDirect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns ((components) => Transport)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.all.html b/functions/_libp2p_websockets.filters.all.html index ed89abc7a8..115d507456 100644 --- a/functions/_libp2p_websockets.filters.all.html +++ b/functions/_libp2p_websockets.filters.all.html @@ -1 +1 @@ -all | libp2p

    Function all

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +all | libp2p

    Function all

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.dnsWsOrWss.html b/functions/_libp2p_websockets.filters.dnsWsOrWss.html index a08702894a..cb2a7b849f 100644 --- a/functions/_libp2p_websockets.filters.dnsWsOrWss.html +++ b/functions/_libp2p_websockets.filters.dnsWsOrWss.html @@ -1 +1 @@ -dnsWsOrWss | libp2p

    Function dnsWsOrWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dnsWsOrWss | libp2p

    Function dnsWsOrWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.dnsWss.html b/functions/_libp2p_websockets.filters.dnsWss.html index 7551be3496..41f2fdfb24 100644 --- a/functions/_libp2p_websockets.filters.dnsWss.html +++ b/functions/_libp2p_websockets.filters.dnsWss.html @@ -1 +1 @@ -dnsWss | libp2p

    Function dnsWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +dnsWss | libp2p

    Function dnsWss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.filters.wss.html b/functions/_libp2p_websockets.filters.wss.html index 0f89c5b746..0af234a4f2 100644 --- a/functions/_libp2p_websockets.filters.wss.html +++ b/functions/_libp2p_websockets.filters.wss.html @@ -1 +1 @@ -wss | libp2p

    Function wss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +wss | libp2p

    Function wss

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_websockets.index.webSockets.html b/functions/_libp2p_websockets.index.webSockets.html index 1cabd1473d..d35d144ce8 100644 --- a/functions/_libp2p_websockets.index.webSockets.html +++ b/functions/_libp2p_websockets.index.webSockets.html @@ -1 +1 @@ -webSockets | libp2p

    Function webSockets

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webSockets | libp2p

    Function webSockets

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/_libp2p_webtransport.webTransport.html b/functions/_libp2p_webtransport.webTransport.html index 0fe7ea4676..f774a066bb 100644 --- a/functions/_libp2p_webtransport.webTransport.html +++ b/functions/_libp2p_webtransport.webTransport.html @@ -1 +1 @@ -webTransport | libp2p

    Function webTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +webTransport | libp2p

    Function webTransport

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/libp2p.index.createLibp2p.html b/functions/libp2p.index.createLibp2p.html index 09d90db511..dc194ac41d 100644 --- a/functions/libp2p.index.createLibp2p.html +++ b/functions/libp2p.index.createLibp2p.html @@ -3,4 +3,4 @@

    The node will be started unless start: false is passed as an option.

    Type Parameters

    Parameters

    Returns Promise<Libp2p<T>>

    Example

    import { createLibp2p } from 'libp2p'
    import { tcp } from '@libp2p/tcp'
    import { mplex } from '@libp2p/mplex'
    import { noise } from '@chainsafe/libp2p-noise'
    import { yamux } from '@chainsafe/libp2p-yamux'

    // specify options
    const options = {
      transports: [tcp()],
      streamMuxers: [yamux(), mplex()],
      connectionEncryption: [noise()]
    }

    // create libp2p
    const libp2p = await createLibp2p(options)
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_libp2p_autonat.AutoNATComponents.html b/interfaces/_libp2p_autonat.AutoNATComponents.html index 0e0b5e42a6..5a9ae37b2c 100644 --- a/interfaces/_libp2p_autonat.AutoNATComponents.html +++ b/interfaces/_libp2p_autonat.AutoNATComponents.html @@ -1,8 +1,8 @@ -AutoNATComponents | libp2p

    Interface AutoNATComponents

    interface AutoNATComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        peerId: PeerId;
        randomWalk: RandomWalk;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager +AutoNATComponents | libp2p

    Interface AutoNATComponents

    interface AutoNATComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        peerId: PeerId;
        randomWalk: RandomWalk;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager connectionManager logger peerId randomWalk registrar transportManager -

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    peerId

    peerId: PeerId

    randomWalk

    randomWalk: RandomWalk

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagerloggerpeerIdrandomWalkregistrartransportManager
    \ No newline at end of file +

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    peerId

    peerId: PeerId

    randomWalk

    randomWalk: RandomWalk

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagerloggerpeerIdrandomWalkregistrartransportManager
    \ No newline at end of file diff --git a/interfaces/_libp2p_autonat.AutoNATServiceInit.html b/interfaces/_libp2p_autonat.AutoNATServiceInit.html index 1661d66f96..b8b7cd8dcb 100644 --- a/interfaces/_libp2p_autonat.AutoNATServiceInit.html +++ b/interfaces/_libp2p_autonat.AutoNATServiceInit.html @@ -1,13 +1,13 @@ -AutoNATServiceInit | libp2p

    Interface AutoNATServiceInit

    interface AutoNATServiceInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        refreshInterval?: number;
        startupDelay?: number;
        timeout?: number;
    }

    Properties

    maxInboundStreams? +AutoNATServiceInit | libp2p

    Interface AutoNATServiceInit

    interface AutoNATServiceInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        refreshInterval?: number;
        startupDelay?: number;
        timeout?: number;
    }

    Properties

    maxInboundStreams? maxOutboundStreams? protocolPrefix? refreshInterval? startupDelay? timeout?

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    How many parallel inbound autoNAT streams we allow per-connection

    -

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    How many parallel outbound autoNAT streams we allow per-connection

    -

    Optional protocolPrefix

    protocolPrefix?: string

    Allows overriding the protocol prefix used

    -

    Optional refreshInterval

    refreshInterval?: number

    Verify our external addresses this often

    -

    Optional startupDelay

    startupDelay?: number

    How long to wait after startup before trying to verify our external address

    -

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to verify our external address

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefixrefreshIntervalstartupDelaytimeout
    \ No newline at end of file +

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    How many parallel outbound autoNAT streams we allow per-connection

    +

    Optional protocolPrefix

    protocolPrefix?: string

    Allows overriding the protocol prefix used

    +

    Optional refreshInterval

    refreshInterval?: number

    Verify our external addresses this often

    +

    Optional startupDelay

    startupDelay?: number

    How long to wait after startup before trying to verify our external address

    +

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to verify our external address

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefixrefreshIntervalstartupDelaytimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_bootstrap.BootstrapComponents.html b/interfaces/_libp2p_bootstrap.BootstrapComponents.html index eb53005cda..f126f382ad 100644 --- a/interfaces/_libp2p_bootstrap.BootstrapComponents.html +++ b/interfaces/_libp2p_bootstrap.BootstrapComponents.html @@ -1,3 +1,3 @@ -BootstrapComponents | libp2p

    Interface BootstrapComponents

    interface BootstrapComponents {
        logger: ComponentLogger;
        peerStore: PeerStore;
    }

    Properties

    logger +BootstrapComponents | libp2p

    Interface BootstrapComponents

    interface BootstrapComponents {
        logger: ComponentLogger;
        peerStore: PeerStore;
    }

    Properties

    logger peerStore -

    Properties

    logger

    logger: ComponentLogger

    peerStore

    peerStore: PeerStore

    Settings

    Member Visibility

    Theme

    On This Page

    loggerpeerStore
    \ No newline at end of file +

    Properties

    logger

    logger: ComponentLogger

    peerStore

    peerStore: PeerStore

    Settings

    Member Visibility

    Theme

    On This Page

    loggerpeerStore
    \ No newline at end of file diff --git a/interfaces/_libp2p_bootstrap.BootstrapInit.html b/interfaces/_libp2p_bootstrap.BootstrapInit.html index 5983b6ace6..7a5916aef5 100644 --- a/interfaces/_libp2p_bootstrap.BootstrapInit.html +++ b/interfaces/_libp2p_bootstrap.BootstrapInit.html @@ -1,11 +1,11 @@ -BootstrapInit | libp2p

    Interface BootstrapInit

    interface BootstrapInit {
        list: string[];
        tagName?: string;
        tagTTL?: number;
        tagValue?: number;
        timeout?: number;
    }

    Properties

    list +BootstrapInit | libp2p

    Interface BootstrapInit

    interface BootstrapInit {
        list: string[];
        tagName?: string;
        tagTTL?: number;
        tagValue?: number;
        timeout?: number;
    }

    Properties

    list tagName? tagTTL? tagValue? timeout?

    Properties

    list

    list: string[]

    The list of peer addresses in multi-address format

    -

    Optional tagName

    tagName?: string

    Tag a bootstrap peer with this name before "discovering" it (default: 'bootstrap')

    -

    Optional tagTTL

    tagTTL?: number

    Cause the bootstrap peer tag to be removed after this number of ms (default: 2 minutes)

    -

    Optional tagValue

    tagValue?: number

    The bootstrap peer tag will have this value (default: 50)

    -

    Optional timeout

    timeout?: number

    How long to wait before discovering bootstrap nodes

    -

    Settings

    Member Visibility

    Theme

    On This Page

    listtagNametagTTLtagValuetimeout
    \ No newline at end of file +

    Optional tagName

    tagName?: string

    Tag a bootstrap peer with this name before "discovering" it (default: 'bootstrap')

    +

    Optional tagTTL

    tagTTL?: number

    Cause the bootstrap peer tag to be removed after this number of ms (default: 2 minutes)

    +

    Optional tagValue

    tagValue?: number

    The bootstrap peer tag will have this value (default: 50)

    +

    Optional timeout

    timeout?: number

    How long to wait before discovering bootstrap nodes

    +

    Settings

    Member Visibility

    Theme

    On This Page

    listtagNametagTTLtagValuetimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html index 55c3a41796..26a6275bff 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html @@ -1,12 +1,12 @@ CircuitRelayService | libp2p

    Interface CircuitRelayService

    An implementation of a typed event target etc

    -
    interface CircuitRelayService {
        #private: any;
        reservations: PeerMap<RelayReservation>;
        addEventListener<K>(type, listener, options?): void;
        dispatchEvent(event): boolean;
        listenerCount(type): number;
        removeEventListener<K>(type, listener?, options?): void;
        safeDispatchEvent<Detail>(type, detail?): boolean;
    }

    Hierarchy (view full)

    Properties

    #private +
    interface CircuitRelayService {
        #private: any;
        reservations: PeerMap<RelayReservation>;
        addEventListener<K>(type, listener, options?): void;
        dispatchEvent(event): boolean;
        listenerCount(type): number;
        removeEventListener<K>(type, listener?, options?): void;
        safeDispatchEvent<Detail>(type, detail?): boolean;
    }

    Hierarchy (view full)

    Properties

    #private reservations

    Methods

    addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

    Properties

    Private #private

    #private: any

    reservations

    reservations: PeerMap<RelayReservation>

    Methods

    addEventListener

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

    Properties

    Private #private

    #private: any

    reservations

    reservations: PeerMap<RelayReservation>

    Methods

    addEventListener

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    listenerCount

    • listenerCount(type): number

    • Parameters

      • type: string

      Returns number

    removeEventListener

    safeDispatchEvent

    Settings

    Member Visibility

    Theme

    On This Page

    #privatereservationsaddEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
    \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html index 4f8108e45d..c0a91eb049 100644 --- a/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html +++ b/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html @@ -1,4 +1,4 @@ -CircuitRelayServiceEvents | libp2p

    Interface CircuitRelayServiceEvents

    interface CircuitRelayServiceEvents {
        relay:advert:error: CustomEvent<Error>;
        relay:advert:success: CustomEvent<unknown>;
        relay:reservation: CustomEvent<RelayReservation>;
    }

    Properties

    relay:advert:error +CircuitRelayServiceEvents | libp2p

    Interface CircuitRelayServiceEvents

    interface CircuitRelayServiceEvents {
        relay:advert:error: CustomEvent<Error>;
        relay:advert:success: CustomEvent<unknown>;
        relay:reservation: CustomEvent<RelayReservation>;
    }

    Properties

    relay:advert:error relay:advert:success relay:reservation -

    Properties

    relay:advert:error

    relay:advert:error: CustomEvent<Error>

    relay:advert:success

    relay:advert:success: CustomEvent<unknown>

    relay:reservation

    relay:reservation: CustomEvent<RelayReservation>

    Settings

    Member Visibility

    Theme

    On This Page

    relay:advert:errorrelay:advert:successrelay:reservation
    \ No newline at end of file +

    Properties

    relay:advert:error

    relay:advert:error: CustomEvent<Error>

    relay:advert:success

    relay:advert:success: CustomEvent<unknown>

    relay:reservation

    relay:reservation: CustomEvent<RelayReservation>

    Settings

    Member Visibility

    Theme

    On This Page

    relay:advert:errorrelay:advert:successrelay:reservation
    \ No newline at end of file diff --git a/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html b/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html index a0e1814ad4..896d0c6109 100644 --- a/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html +++ b/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html @@ -1,4 +1,4 @@ -RelayReservation | libp2p

    Interface RelayReservation

    interface RelayReservation {
        addr: Multiaddr;
        expire: Date;
        limit?: Limit;
    }

    Properties

    addr +RelayReservation | libp2p

    Interface RelayReservation

    interface RelayReservation {
        addr: Multiaddr;
        expire: Date;
        limit?: Limit;
    }

    Properties

    addr expire limit? -

    Properties

    addr

    addr: Multiaddr

    expire

    expire: Date

    Optional limit

    limit?: Limit

    Settings

    Member Visibility

    Theme

    On This Page

    addrexpirelimit
    \ No newline at end of file +

    Properties

    addr

    addr: Multiaddr

    expire

    expire: Date

    Optional limit

    limit?: Limit

    Settings

    Member Visibility

    Theme

    On This Page

    addrexpirelimit
    \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.hmac.HMAC.html b/interfaces/_libp2p_crypto.hmac.HMAC.html index 3b5596a955..dc1643cfd3 100644 --- a/interfaces/_libp2p_crypto.hmac.HMAC.html +++ b/interfaces/_libp2p_crypto.hmac.HMAC.html @@ -1,3 +1,3 @@ -HMAC | libp2p

    Interface HMAC

    interface HMAC {
        length: number;
        digest(data): Promise<Uint8Array>;
    }

    Properties

    length +HMAC | libp2p

    Interface HMAC

    interface HMAC {
        length: number;
        digest(data): Promise<Uint8Array>;
    }

    Properties

    length

    Methods

    digest -

    Properties

    length

    length: number

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    lengthdigest
    \ No newline at end of file +

    Properties

    length

    length: number

    Methods

    digest

    Settings

    Member Visibility

    Theme

    On This Page

    lengthdigest
    \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.JWKKeyPair.html b/interfaces/_libp2p_crypto.keys.JWKKeyPair.html index a987c289cc..1a3ae2963a 100644 --- a/interfaces/_libp2p_crypto.keys.JWKKeyPair.html +++ b/interfaces/_libp2p_crypto.keys.JWKKeyPair.html @@ -1,3 +1,3 @@ -JWKKeyPair | libp2p

    Interface JWKKeyPair

    interface JWKKeyPair {
        privateKey: JsonWebKey;
        publicKey: JsonWebKey;
    }

    Properties

    privateKey +JWKKeyPair | libp2p

    Interface JWKKeyPair

    interface JWKKeyPair {
        privateKey: JsonWebKey;
        publicKey: JsonWebKey;
    }

    Properties

    privateKey publicKey -

    Properties

    privateKey

    privateKey: JsonWebKey

    publicKey

    publicKey: JsonWebKey

    Settings

    Member Visibility

    Theme

    On This Page

    privateKeypublicKey
    \ No newline at end of file +

    Properties

    privateKey

    privateKey: JsonWebKey

    publicKey

    publicKey: JsonWebKey

    Settings

    Member Visibility

    Theme

    On This Page

    privateKeypublicKey
    \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.keysPBM.PrivateKey-1.html b/interfaces/_libp2p_crypto.keys.keysPBM.PrivateKey-1.html index a5ab9c48ef..17faea642f 100644 --- a/interfaces/_libp2p_crypto.keys.keysPBM.PrivateKey-1.html +++ b/interfaces/_libp2p_crypto.keys.keysPBM.PrivateKey-1.html @@ -1,3 +1,3 @@ -PrivateKey | libp2p

    Interface PrivateKey

    interface PrivateKey {
        Data?: Uint8Array;
        Type?: keysPBM.KeyType;
    }

    Properties

    Data? +PrivateKey | libp2p

    Interface PrivateKey

    interface PrivateKey {
        Data?: Uint8Array;
        Type?: keysPBM.KeyType;
    }

    Properties

    Data? Type? -

    Properties

    Optional Data

    Data?: Uint8Array

    Optional Type

    Type?: keysPBM.KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    DataType
    \ No newline at end of file +

    Properties

    Optional Data

    Data?: Uint8Array

    Optional Type

    Type?: keysPBM.KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    DataType
    \ No newline at end of file diff --git a/interfaces/_libp2p_crypto.keys.keysPBM.PublicKey-1.html b/interfaces/_libp2p_crypto.keys.keysPBM.PublicKey-1.html index 9503df06b3..4c217e0c9d 100644 --- a/interfaces/_libp2p_crypto.keys.keysPBM.PublicKey-1.html +++ b/interfaces/_libp2p_crypto.keys.keysPBM.PublicKey-1.html @@ -1,3 +1,3 @@ -PublicKey | libp2p

    Interface PublicKey

    interface PublicKey {
        Data?: Uint8Array;
        Type?: keysPBM.KeyType;
    }

    Properties

    Data? +PublicKey | libp2p

    Interface PublicKey

    interface PublicKey {
        Data?: Uint8Array;
        Type?: keysPBM.KeyType;
    }

    Properties

    Data? Type? -

    Properties

    Optional Data

    Data?: Uint8Array

    Optional Type

    Type?: keysPBM.KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    DataType
    \ No newline at end of file +

    Properties

    Optional Data

    Data?: Uint8Array

    Optional Type

    Type?: keysPBM.KeyType

    Settings

    Member Visibility

    Theme

    On This Page

    DataType
    \ No newline at end of file diff --git a/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html b/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html index 6ab998a7a8..6b2a89cf35 100644 --- a/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html +++ b/interfaces/_libp2p_dcutr.DCUtRServiceComponents.html @@ -1,7 +1,7 @@ -DCUtRServiceComponents | libp2p

    Interface DCUtRServiceComponents

    interface DCUtRServiceComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        peerStore: PeerStore;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager +DCUtRServiceComponents | libp2p

    Interface DCUtRServiceComponents

    interface DCUtRServiceComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        peerStore: PeerStore;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager connectionManager logger peerStore registrar transportManager -

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagerloggerpeerStoreregistrartransportManager
    \ No newline at end of file +

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagerloggerpeerStoreregistrartransportManager
    \ No newline at end of file diff --git a/interfaces/_libp2p_dcutr.DCUtRServiceInit.html b/interfaces/_libp2p_dcutr.DCUtRServiceInit.html index e1ef7049ea..2c5b61fad4 100644 --- a/interfaces/_libp2p_dcutr.DCUtRServiceInit.html +++ b/interfaces/_libp2p_dcutr.DCUtRServiceInit.html @@ -1,11 +1,11 @@ -DCUtRServiceInit | libp2p

    Interface DCUtRServiceInit

    interface DCUtRServiceInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        retries?: number;
        timeout?: number;
    }

    Properties

    maxInboundStreams? +DCUtRServiceInit | libp2p

    Interface DCUtRServiceInit

    interface DCUtRServiceInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        retries?: number;
        timeout?: number;
    }

    Properties

    maxInboundStreams? maxOutboundStreams? retries? timeout?

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    How many simultaneous inbound DCUtR protocol streams to allow on each connection (default: 1)

    -

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    How many simultaneous outbound DCUtR protocol streams to allow on each +

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    How many simultaneous outbound DCUtR protocol streams to allow on each connection (default: 1)

    -

    Optional retries

    retries?: number

    How many times to retry the connection upgrade (default: 3)

    -

    Optional timeout

    timeout?: number

    How long we should wait for the connection upgrade to complete (default: 5s)

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsretriestimeout
    \ No newline at end of file +

    Optional retries

    retries?: number

    How many times to retry the connection upgrade (default: 3)

    +

    Optional timeout

    timeout?: number

    How long we should wait for the connection upgrade to complete (default: 5s)

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsretriestimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.Address.html b/interfaces/_libp2p_devtools_metrics.Address.html index d83ee5393a..91433dcc95 100644 --- a/interfaces/_libp2p_devtools_metrics.Address.html +++ b/interfaces/_libp2p_devtools_metrics.Address.html @@ -1,8 +1,8 @@ -Address | libp2p

    Interface Address

    interface Address {
        isCertified?: boolean;
        isConnected?: boolean;
        multiaddr: string;
    }

    Properties

    isCertified? +Address | libp2p

    Interface Address

    interface Address {
        isCertified?: boolean;
        isConnected?: boolean;
        multiaddr: string;
    }

    Properties

    isCertified? isConnected? multiaddr

    Properties

    Optional isCertified

    isCertified?: boolean

    If true, this multiaddr came from a signed peer record

    -

    Optional isConnected

    isConnected?: boolean

    If true, the current node has an active connection to this peer via this +

    Optional isConnected

    isConnected?: boolean

    If true, the current node has an active connection to this peer via this address

    -

    multiaddr

    multiaddr: string

    The multiaddr this address represents

    -

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedisConnectedmultiaddr
    \ No newline at end of file +

    multiaddr

    multiaddr: string

    The multiaddr this address represents

    +

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedisConnectedmultiaddr
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html b/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html index 28279deeb4..3262bb3cd8 100644 --- a/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html +++ b/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html @@ -1,7 +1,7 @@ CopyToClipboardMessage | libp2p

    Interface CopyToClipboardMessage

    This event is intercepted by the service worker which injects a content script into the current page which copies the passed value to the clipboard.

    -
    interface CopyToClipboardMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "copy-to-clipboard";
        value: string;
    }

    Properties

    source +
    interface CopyToClipboardMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "copy-to-clipboard";
        value: string;
    }

    Properties

    source tabId type value -

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "copy-to-clipboard"

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtypevalue
    \ No newline at end of file +

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "copy-to-clipboard"

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtypevalue
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.DevToolsEvents.html b/interfaces/_libp2p_devtools_metrics.DevToolsEvents.html index ab6fac894a..4b0b856be7 100644 --- a/interfaces/_libp2p_devtools_metrics.DevToolsEvents.html +++ b/interfaces/_libp2p_devtools_metrics.DevToolsEvents.html @@ -1,7 +1,7 @@ -DevToolsEvents | libp2p

    Interface DevToolsEvents

    interface DevToolsEvents {
        metrics: CustomEvent<Record<string, any>>;
        peers: CustomEvent<Peer[]>;
        self: CustomEvent<Peer>;
    }

    Properties

    metrics +DevToolsEvents | libp2p

    Interface DevToolsEvents

    interface DevToolsEvents {
        metrics: CustomEvent<Record<string, any>>;
        peers: CustomEvent<Peer[]>;
        self: CustomEvent<Peer>;
    }

    Properties

    metrics peers self

    Properties

    metrics

    metrics: CustomEvent<Record<string, any>>

    Node metrics have been updated

    -

    peers

    peers: CustomEvent<Peer[]>

    The node's connected peers have changed

    -

    self

    self: CustomEvent<Peer>

    The node's status has changed - new addresses and/or protocols, etc

    -

    Settings

    Member Visibility

    Theme

    On This Page

    metricspeersself
    \ No newline at end of file +

    peers

    peers: CustomEvent<Peer[]>

    The node's connected peers have changed

    +

    self

    self: CustomEvent<Peer>

    The node's status has changed - new addresses and/or protocols, etc

    +

    Settings

    Member Visibility

    Theme

    On This Page

    metricspeersself
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html b/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html index 19afb5d42a..9603afdce8 100644 --- a/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html +++ b/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html @@ -1,4 +1,4 @@ -DevToolsMetricsComponents | libp2p

    Interface DevToolsMetricsComponents

    interface DevToolsMetricsComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        contentRouting: ContentRouting;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        peerId: PeerId;
        peerRouting: PeerRouting;
        peerStore: PeerStore;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager +DevToolsMetricsComponents | libp2p

    Interface DevToolsMetricsComponents

    interface DevToolsMetricsComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        contentRouting: ContentRouting;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        peerId: PeerId;
        peerRouting: PeerRouting;
        peerStore: PeerStore;
        registrar: Registrar;
        transportManager: TransportManager;
    }

    Properties

    addressManager connectionManager contentRouting events @@ -8,4 +8,4 @@ peerStore registrar transportManager -

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    contentRouting

    contentRouting: ContentRouting

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    peerId

    peerId: PeerId

    peerRouting

    peerRouting: PeerRouting

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagercontentRoutingeventsloggerpeerIdpeerRoutingpeerStoreregistrartransportManager
    \ No newline at end of file +

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    contentRouting

    contentRouting: ContentRouting

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    peerId

    peerId: PeerId

    peerRouting

    peerRouting: PeerRouting

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    transportManager

    transportManager: TransportManager

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagercontentRoutingeventsloggerpeerIdpeerRoutingpeerStoreregistrartransportManager
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html b/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html index 59f88862a4..7a6caaa76c 100644 --- a/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html +++ b/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html @@ -1,3 +1,3 @@ -DevToolsMetricsInit | libp2p

    Interface DevToolsMetricsInit

    interface DevToolsMetricsInit {
        intervalMs?: number;
    }

    Properties

    intervalMs? +DevToolsMetricsInit | libp2p

    Interface DevToolsMetricsInit

    interface DevToolsMetricsInit {
        intervalMs?: number;
    }

    Properties

    intervalMs?

    Properties

    Optional intervalMs

    intervalMs?: number

    How often to pass metrics to the DevTools panel

    -

    Settings

    Member Visibility

    Theme

    On This Page

    intervalMs
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    intervalMs
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.DevToolsRPC.html b/interfaces/_libp2p_devtools_metrics.DevToolsRPC.html index a67c640481..7cd8fcbaba 100644 --- a/interfaces/_libp2p_devtools_metrics.DevToolsRPC.html +++ b/interfaces/_libp2p_devtools_metrics.DevToolsRPC.html @@ -1,3 +1,3 @@ DevToolsRPC | libp2p

    Interface DevToolsRPC

    RPC operations exposed by the DevTools

    -
    interface DevToolsRPC {
        safeDispatchEvent<Detail>(type, detail?): Promise<void>;
    }

    Methods

    safeDispatchEvent -

    Methods

    safeDispatchEvent

    Settings

    Member Visibility

    Theme

    On This Page

    safeDispatchEvent
    \ No newline at end of file +
    interface DevToolsRPC {
        safeDispatchEvent<Detail>(type, detail?): Promise<void>;
    }

    Methods

    safeDispatchEvent +

    Methods

    safeDispatchEvent

    Settings

    Member Visibility

    Theme

    On This Page

    safeDispatchEvent
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.MetricsRPC.html b/interfaces/_libp2p_devtools_metrics.MetricsRPC.html index 0676c8579d..bda1d35588 100644 --- a/interfaces/_libp2p_devtools_metrics.MetricsRPC.html +++ b/interfaces/_libp2p_devtools_metrics.MetricsRPC.html @@ -1,14 +1,14 @@ MetricsRPC | libp2p

    Interface MetricsRPC

    RPC operations exposed by the metrics

    -
    interface MetricsRPC {
        contentRouting: ContentRouting;
        peerRouting: PeerRouting;
        closeConnection(peerId, options?): Promise<void>;
        init(options?): Promise<{
            debug: string;
            peers: Peer[];
            self: Peer;
        }>;
        openConnection(peerIdOrMultiaddr, options?): Promise<void>;
        setDebug(namespace?): Promise<void>;
    }

    Properties

    contentRouting +
    interface MetricsRPC {
        contentRouting: ContentRouting;
        peerRouting: PeerRouting;
        closeConnection(peerId, options?): Promise<void>;
        init(options?): Promise<{
            debug: string;
            peers: Peer[];
            self: Peer;
        }>;
        openConnection(peerIdOrMultiaddr, options?): Promise<void>;
        setDebug(namespace?): Promise<void>;
    }

    Properties

    contentRouting peerRouting

    Methods

    closeConnection init openConnection setDebug

    Properties

    contentRouting

    contentRouting: ContentRouting

    Make content routing queries

    -

    peerRouting

    peerRouting: PeerRouting

    Make peer routing queries

    -

    Methods

    closeConnection

    init

    • init(options?): Promise<{
          debug: string;
          peers: Peer[];
          self: Peer;
      }>

    • Called by DevTools on initial connect

      -

      Parameters

      Returns Promise<{
          debug: string;
          peers: Peer[];
          self: Peer;
      }>

    openConnection

    setDebug

    • setDebug(namespace?): Promise<void>

    • Update the currently active debugging namespaces

      -

      Parameters

      • Optional namespace: string

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    contentRoutingpeerRoutingcloseConnectioninitopenConnectionsetDebug
    \ No newline at end of file +

    peerRouting

    peerRouting: PeerRouting

    Make peer routing queries

    +

    Methods

    closeConnection

    init

    • init(options?): Promise<{
          debug: string;
          peers: Peer[];
          self: Peer;
      }>

    • Called by DevTools on initial connect

      +

      Parameters

      Returns Promise<{
          debug: string;
          peers: Peer[];
          self: Peer;
      }>

    openConnection

    setDebug

    • setDebug(namespace?): Promise<void>

    • Update the currently active debugging namespaces

      +

      Parameters

      • Optional namespace: string

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    contentRoutingpeerRoutingcloseConnectioninitopenConnectionsetDebug
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.NodeAddress.html b/interfaces/_libp2p_devtools_metrics.NodeAddress.html index 19040f52f7..61f04838c8 100644 --- a/interfaces/_libp2p_devtools_metrics.NodeAddress.html +++ b/interfaces/_libp2p_devtools_metrics.NodeAddress.html @@ -1,6 +1,6 @@ -NodeAddress | libp2p

    Interface NodeAddress

    interface NodeAddress {
        announce?: boolean;
        default?: boolean;
        listen?: boolean;
        multiaddr: Multiaddr;
        observed?: boolean;
    }

    Properties

    announce? +NodeAddress | libp2p

    Interface NodeAddress

    interface NodeAddress {
        announce?: boolean;
        default?: boolean;
        listen?: boolean;
        multiaddr: Multiaddr;
        observed?: boolean;
    }

    Properties

    announce? default? listen? multiaddr observed? -

    Properties

    Optional announce

    announce?: boolean

    Optional default

    default?: boolean

    Optional listen

    listen?: boolean

    multiaddr

    multiaddr: Multiaddr

    Optional observed

    observed?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    announcedefaultlistenmultiaddrobserved
    \ No newline at end of file +

    Properties

    Optional announce

    announce?: boolean

    Optional default

    default?: boolean

    Optional listen

    listen?: boolean

    multiaddr

    multiaddr: Multiaddr

    Optional observed

    observed?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    announcedefaultlistenmultiaddrobserved
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.NodeStatus.html b/interfaces/_libp2p_devtools_metrics.NodeStatus.html index aff40c5b27..1af4fff412 100644 --- a/interfaces/_libp2p_devtools_metrics.NodeStatus.html +++ b/interfaces/_libp2p_devtools_metrics.NodeStatus.html @@ -1,5 +1,5 @@ -NodeStatus | libp2p

    Interface NodeStatus

    interface NodeStatus {
        addresses: NodeAddress[];
        agent?: string;
        peerId: PeerId;
        protocols: string[];
    }

    Properties

    addresses +NodeStatus | libp2p

    Interface NodeStatus

    interface NodeStatus {
        addresses: NodeAddress[];
        agent?: string;
        peerId: PeerId;
        protocols: string[];
    }

    Properties

    addresses agent? peerId protocols -

    Properties

    addresses

    addresses: NodeAddress[]

    Optional agent

    agent?: string

    peerId

    peerId: PeerId

    protocols

    protocols: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    addressesagentpeerIdprotocols
    \ No newline at end of file +

    Properties

    addresses

    addresses: NodeAddress[]

    Optional agent

    agent?: string

    peerId

    peerId: PeerId

    protocols

    protocols: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    addressesagentpeerIdprotocols
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html b/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html index 3666df867a..42dfc4bf52 100644 --- a/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html +++ b/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html @@ -1,6 +1,6 @@ PageLoadedMessage | libp2p

    Interface PageLoadedMessage

    Sent by the DevTools service worker to the DevTools panel when the inspected page has finished (re)loading

    -
    interface PageLoadedMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "page-loaded";
    }

    Properties

    source +
    interface PageLoadedMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "page-loaded";
    }

    Properties

    source tabId type -

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "page-loaded"

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtype
    \ No newline at end of file +

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "page-loaded"

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtype
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.Peer.html b/interfaces/_libp2p_devtools_metrics.Peer.html index e4819776f3..c09c9bd2c2 100644 --- a/interfaces/_libp2p_devtools_metrics.Peer.html +++ b/interfaces/_libp2p_devtools_metrics.Peer.html @@ -1,11 +1,11 @@ -Peer | libp2p

    Interface Peer

    interface Peer {
        addresses: PeerAddress[];
        id: PeerId;
        metadata: Record<string, string>;
        protocols: string[];
        tags: Record<string, number>;
    }

    Properties

    addresses +Peer | libp2p

    Interface Peer

    interface Peer {
        addresses: PeerAddress[];
        id: PeerId;
        metadata: Record<string, string>;
        protocols: string[];
        tags: Record<string, number>;
    }

    Properties

    addresses id metadata protocols tags

    Properties

    addresses

    addresses: PeerAddress[]

    The list of addresses the peer has that we know about

    -

    id

    id: PeerId

    The identifier of the remote peer

    -

    metadata

    metadata: Record<string, string>

    Any peer store metadata the peer has

    -

    protocols

    protocols: string[]

    The protocols the peer supports, if known

    -

    tags

    tags: Record<string, number>

    Any peer store tags the peer has

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addressesidmetadataprotocolstags
    \ No newline at end of file +

    id

    id: PeerId

    The identifier of the remote peer

    +

    metadata

    metadata: Record<string, string>

    Any peer store metadata the peer has

    +

    protocols

    protocols: string[]

    The protocols the peer supports, if known

    +

    tags

    tags: Record<string, number>

    Any peer store tags the peer has

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addressesidmetadataprotocolstags
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.PeerAddress.html b/interfaces/_libp2p_devtools_metrics.PeerAddress.html index bd42a7967f..52514ba1b6 100644 --- a/interfaces/_libp2p_devtools_metrics.PeerAddress.html +++ b/interfaces/_libp2p_devtools_metrics.PeerAddress.html @@ -1,4 +1,4 @@ -PeerAddress | libp2p

    Interface PeerAddress

    interface PeerAddress {
        isCertified?: boolean;
        isConnected?: boolean;
        multiaddr: Multiaddr;
    }

    Properties

    isCertified? +PeerAddress | libp2p

    Interface PeerAddress

    interface PeerAddress {
        isCertified?: boolean;
        isConnected?: boolean;
        multiaddr: Multiaddr;
    }

    Properties

    isCertified? isConnected? multiaddr -

    Properties

    Optional isCertified

    isCertified?: boolean

    Optional isConnected

    isConnected?: boolean

    multiaddr

    multiaddr: Multiaddr

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedisConnectedmultiaddr
    \ No newline at end of file +

    Properties

    Optional isCertified

    isCertified?: boolean

    Optional isConnected

    isConnected?: boolean

    multiaddr

    multiaddr: Multiaddr

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedisConnectedmultiaddr
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html b/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html index 0d8c56b8be..f274b77d31 100644 --- a/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html +++ b/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html @@ -2,7 +2,7 @@ to send a message to the inspected page as there is no receiving end present.

    This normally means the content script has not been loaded due to the user not having granted permission for the script to run.

    -
    interface PermissionsErrorMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "permissions-error";
    }

    Properties

    source +
    interface PermissionsErrorMessage {
        source: "@libp2p/devtools-metrics:devtools";
        tabId: number;
        type: "permissions-error";
    }

    Properties

    source tabId type -

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "permissions-error"

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtype
    \ No newline at end of file +

    Properties

    source

    source: "@libp2p/devtools-metrics:devtools"

    tabId

    tabId: number

    type

    type: "permissions-error"

    Settings

    Member Visibility

    Theme

    On This Page

    sourcetabIdtype
    \ No newline at end of file diff --git a/interfaces/_libp2p_devtools_metrics.RPCMessage.html b/interfaces/_libp2p_devtools_metrics.RPCMessage.html index adb871b03a..343a2974f8 100644 --- a/interfaces/_libp2p_devtools_metrics.RPCMessage.html +++ b/interfaces/_libp2p_devtools_metrics.RPCMessage.html @@ -1,7 +1,7 @@ RPCMessage | libp2p

    Interface RPCMessage

    Invoke a method on the libp2p object

    -
    interface RPCMessage {
        message: string;
        source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics";
        tabId: number;
        type: "libp2p-rpc";
    }

    Properties

    message +
    interface RPCMessage {
        message: string;
        source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics";
        tabId: number;
        type: "libp2p-rpc";
    }

    Properties

    message source tabId type

    Properties

    message

    message: string

    The RPC message encoded as a multibase string

    -

    source

    source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics"

    tabId

    tabId: number

    type

    type: "libp2p-rpc"

    Settings

    Member Visibility

    Theme

    On This Page

    messagesourcetabIdtype
    \ No newline at end of file +

    source

    source: "@libp2p/devtools-metrics:devtools" | "@libp2p/devtools-metrics:metrics"

    tabId

    tabId: number

    type

    type: "libp2p-rpc"

    Settings

    Member Visibility

    Theme

    On This Page

    messagesourcetabIdtype
    \ No newline at end of file diff --git a/interfaces/_libp2p_echo.Echo.html b/interfaces/_libp2p_echo.Echo.html index 12d497c6bd..8f65f4c033 100644 --- a/interfaces/_libp2p_echo.Echo.html +++ b/interfaces/_libp2p_echo.Echo.html @@ -1,2 +1,2 @@ -Echo | libp2p

    Interface Echo

    interface Echo {
        protocol: string;
    }

    Properties

    protocol -

    Properties

    protocol

    protocol: string

    Settings

    Member Visibility

    Theme

    On This Page

    protocol
    \ No newline at end of file +Echo | libp2p

    Interface Echo

    interface Echo {
        protocol: string;
    }

    Properties

    protocol +

    Properties

    protocol

    protocol: string

    Settings

    Member Visibility

    Theme

    On This Page

    protocol
    \ No newline at end of file diff --git a/interfaces/_libp2p_echo.EchoComponents.html b/interfaces/_libp2p_echo.EchoComponents.html index ec47f8d1ef..7fa3cf76ea 100644 --- a/interfaces/_libp2p_echo.EchoComponents.html +++ b/interfaces/_libp2p_echo.EchoComponents.html @@ -1,4 +1,4 @@ -EchoComponents | libp2p

    Interface EchoComponents

    interface EchoComponents {
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        registrar: Registrar;
    }

    Properties

    connectionManager +EchoComponents | libp2p

    Interface EchoComponents

    interface EchoComponents {
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        registrar: Registrar;
    }

    Properties

    connectionManager logger registrar -

    Properties

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    connectionManagerloggerregistrar
    \ No newline at end of file +

    Properties

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    connectionManagerloggerregistrar
    \ No newline at end of file diff --git a/interfaces/_libp2p_echo.EchoInit.html b/interfaces/_libp2p_echo.EchoInit.html index 3f551740c8..700e90dec0 100644 --- a/interfaces/_libp2p_echo.EchoInit.html +++ b/interfaces/_libp2p_echo.EchoInit.html @@ -1,4 +1,4 @@ -EchoInit | libp2p

    Interface EchoInit

    interface EchoInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
    }

    Properties

    maxInboundStreams? +EchoInit | libp2p

    Interface EchoInit

    interface EchoInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
    }

    Properties

    maxInboundStreams? maxOutboundStreams? protocolPrefix? -

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    Optional protocolPrefix

    protocolPrefix?: string

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefix
    \ No newline at end of file +

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    Optional protocolPrefix

    protocolPrefix?: string

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefix
    \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.Fetch.html b/interfaces/_libp2p_fetch.Fetch.html index e1782b13a8..40ed01705d 100644 --- a/interfaces/_libp2p_fetch.Fetch.html +++ b/interfaces/_libp2p_fetch.Fetch.html @@ -1,13 +1,13 @@ -Fetch | libp2p

    Interface Fetch

    interface Fetch {
        fetch(peer, key, options?): Promise<undefined | Uint8Array>;
        registerLookupFunction(prefix, lookup): void;
        unregisterLookupFunction(prefix, lookup?): void;
    }

    Methods

    fetch +Fetch | libp2p

    Interface Fetch

    interface Fetch {
        fetch(peer, key, options?): Promise<undefined | Uint8Array>;
        registerLookupFunction(prefix, lookup): void;
        unregisterLookupFunction(prefix, lookup?): void;
    }

    Methods

    fetch registerLookupFunction unregisterLookupFunction

    Methods

    fetch

    registerLookupFunction

    • registerLookupFunction(prefix, lookup): void

    • Registers a new lookup callback that can map keys to values, for a given set of keys that +

      Parameters

      Returns Promise<undefined | Uint8Array>

    registerLookupFunction

    • registerLookupFunction(prefix, lookup): void

    • Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix

      Parameters

      Returns void

      Example

      // ...
      libp2p.services.fetch.registerLookupFunction('/prefix', (key) => { ... })
      -

    unregisterLookupFunction

    • unregisterLookupFunction(prefix, lookup?): void

    • Registers a new lookup callback that can map keys to values, for a given set of keys that +

    unregisterLookupFunction

    • unregisterLookupFunction(prefix, lookup?): void

    • Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix.

      Parameters

      Returns void

      Example

      // ...
      libp2p.services.fetch.unregisterLookupFunction('/prefix')
      -

    Settings

    Member Visibility

    Theme

    On This Page

    fetchregisterLookupFunctionunregisterLookupFunction
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    fetchregisterLookupFunctionunregisterLookupFunction
    \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.FetchComponents.html b/interfaces/_libp2p_fetch.FetchComponents.html index 374d712d64..f5d66329c9 100644 --- a/interfaces/_libp2p_fetch.FetchComponents.html +++ b/interfaces/_libp2p_fetch.FetchComponents.html @@ -1,4 +1,4 @@ -FetchComponents | libp2p

    Interface FetchComponents

    interface FetchComponents {
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        registrar: Registrar;
    }

    Properties

    connectionManager +FetchComponents | libp2p

    Interface FetchComponents

    interface FetchComponents {
        connectionManager: ConnectionManager;
        logger: ComponentLogger;
        registrar: Registrar;
    }

    Properties

    connectionManager logger registrar -

    Properties

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    connectionManagerloggerregistrar
    \ No newline at end of file +

    Properties

    connectionManager

    connectionManager: ConnectionManager

    logger

    logger: ComponentLogger

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    connectionManagerloggerregistrar
    \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.FetchInit.html b/interfaces/_libp2p_fetch.FetchInit.html index eb619b5e18..5a76f4afc1 100644 --- a/interfaces/_libp2p_fetch.FetchInit.html +++ b/interfaces/_libp2p_fetch.FetchInit.html @@ -1,6 +1,6 @@ -FetchInit | libp2p

    Interface FetchInit

    interface FetchInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        timeout?: number;
    }

    Properties

    maxInboundStreams? +FetchInit | libp2p

    Interface FetchInit

    interface FetchInit {
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        timeout?: number;
    }

    Properties

    maxInboundStreams? maxOutboundStreams? protocolPrefix? timeout? -

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    Optional protocolPrefix

    protocolPrefix?: string

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send any data

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefixtimeout
    \ No newline at end of file +

    Properties

    Optional maxInboundStreams

    maxInboundStreams?: number

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    Optional protocolPrefix

    protocolPrefix?: string

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send any data

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxInboundStreamsmaxOutboundStreamsprotocolPrefixtimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_fetch.LookupFunction.html b/interfaces/_libp2p_fetch.LookupFunction.html index 41405ab84f..a1ea2ed28a 100644 --- a/interfaces/_libp2p_fetch.LookupFunction.html +++ b/interfaces/_libp2p_fetch.LookupFunction.html @@ -1 +1 @@ -LookupFunction | libp2p

    Interface LookupFunction

    interface LookupFunction ((key) => Promise<undefined | Uint8Array>)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +LookupFunction | libp2p

    Interface LookupFunction

    interface LookupFunction ((key) => Promise<undefined | Uint8Array>)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_libp2p_floodsub.FloodSubComponents.html b/interfaces/_libp2p_floodsub.FloodSubComponents.html index 6d588bc445..cb1d77ec17 100644 --- a/interfaces/_libp2p_floodsub.FloodSubComponents.html +++ b/interfaces/_libp2p_floodsub.FloodSubComponents.html @@ -1,4 +1,4 @@ -FloodSubComponents | libp2p

    Interface FloodSubComponents

    interface FloodSubComponents {
        logger: ComponentLogger;
        peerId: PeerId;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    logger +FloodSubComponents | libp2p

    Interface FloodSubComponents

    interface FloodSubComponents {
        logger: ComponentLogger;
        peerId: PeerId;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    logger peerId registrar

    Properties

    logger

    logger: ComponentLogger

    peerId

    peerId: PeerId

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    loggerpeerIdregistrar
    \ No newline at end of file diff --git a/interfaces/_libp2p_floodsub.FloodSubInit.html b/interfaces/_libp2p_floodsub.FloodSubInit.html index 9ab41c71fc..7379403c94 100644 --- a/interfaces/_libp2p_floodsub.FloodSubInit.html +++ b/interfaces/_libp2p_floodsub.FloodSubInit.html @@ -1,4 +1,4 @@ -FloodSubInit | libp2p

    Interface FloodSubInit

    interface FloodSubInit {
        canRelayMessage?: boolean;
        emitSelf?: boolean;
        enabled?: boolean;
        globalSignaturePolicy?: SignaturePolicy;
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        messageProcessingConcurrency?: number;
        multicodecs?: string[];
        seenTTL?: number;
    }

    Hierarchy (view full)

    Properties

    canRelayMessage? +FloodSubInit | libp2p

    Interface FloodSubInit

    interface FloodSubInit {
        canRelayMessage?: boolean;
        emitSelf?: boolean;
        enabled?: boolean;
        globalSignaturePolicy?: SignaturePolicy;
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        messageProcessingConcurrency?: number;
        multicodecs?: string[];
        seenTTL?: number;
    }

    Hierarchy (view full)

    Properties

    canRelayMessage? emitSelf? enabled? globalSignaturePolicy? @@ -13,4 +13,4 @@

    Optional maxInboundStreams

    maxInboundStreams?: number

    How many parallel incoming streams to allow on the pubsub protocol per-connection

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    How many parallel outgoing streams to allow on the pubsub protocol per-connection

    Optional messageProcessingConcurrency

    messageProcessingConcurrency?: number

    handle this many incoming pubsub messages concurrently

    -

    Optional multicodecs

    multicodecs?: string[]

    Optional seenTTL

    seenTTL?: number

    Settings

    Member Visibility

    Theme

    On This Page

    canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecsseenTTL
    \ No newline at end of file +

    Optional multicodecs

    multicodecs?: string[]

    Optional seenTTL

    seenTTL?: number

    Settings

    Member Visibility

    Theme

    On This Page

    canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecsseenTTL
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.Identify.html b/interfaces/_libp2p_identify.Identify.html index 2c5a58242e..9be6bffd56 100644 --- a/interfaces/_libp2p_identify.Identify.html +++ b/interfaces/_libp2p_identify.Identify.html @@ -1,7 +1,7 @@ -Identify | libp2p

    Interface Identify

    interface Identify {
        identify(connection, options?): Promise<IdentifyResult>;
    }

    Methods

    identify +Identify | libp2p

    Interface Identify

    interface Identify {
        identify(connection, options?): Promise<IdentifyResult>;
    }

    Methods

    identify

    Methods

    identify

    • identify(connection, options?): Promise<IdentifyResult>

    • due to the default limits on inbound/outbound streams for this protocol, invoking this method when runOnConnectionOpen is true can lead to unpredictable results as streams may be closed by the local or the remote node. Please use with caution. If you find yourself needing to call this method to discover other peers that support your protocol, you may be better off configuring a topology to be notified instead.

      -

      Parameters

      Returns Promise<IdentifyResult>

    Settings

    Member Visibility

    Theme

    On This Page

    identify
    \ No newline at end of file +

    Parameters

    Returns Promise<IdentifyResult>

    Settings

    Member Visibility

    Theme

    On This Page

    identify
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyComponents.html b/interfaces/_libp2p_identify.IdentifyComponents.html index 3603be2e23..937da35e7f 100644 --- a/interfaces/_libp2p_identify.IdentifyComponents.html +++ b/interfaces/_libp2p_identify.IdentifyComponents.html @@ -1,8 +1,8 @@ -IdentifyComponents | libp2p

    Interface IdentifyComponents

    interface IdentifyComponents {
        addressManager: AddressManager;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        nodeInfo: NodeInfo;
        peerId: PeerId;
        peerStore: PeerStore;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    addressManager +IdentifyComponents | libp2p

    Interface IdentifyComponents

    interface IdentifyComponents {
        addressManager: AddressManager;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        nodeInfo: NodeInfo;
        peerId: PeerId;
        peerStore: PeerStore;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    addressManager events logger nodeInfo peerId peerStore registrar -

    Properties

    addressManager

    addressManager: AddressManager

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    nodeInfo

    nodeInfo: NodeInfo

    peerId

    peerId: PeerId

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagereventsloggernodeInfopeerIdpeerStoreregistrar
    \ No newline at end of file +

    Properties

    addressManager

    addressManager: AddressManager

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    nodeInfo

    nodeInfo: NodeInfo

    peerId

    peerId: PeerId

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagereventsloggernodeInfopeerIdpeerStoreregistrar
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyInit.html b/interfaces/_libp2p_identify.IdentifyInit.html index 9bf036804c..c8c28d10c8 100644 --- a/interfaces/_libp2p_identify.IdentifyInit.html +++ b/interfaces/_libp2p_identify.IdentifyInit.html @@ -1,4 +1,4 @@ -IdentifyInit | libp2p

    Interface IdentifyInit

    interface IdentifyInit {
        agentVersion?: string;
        maxInboundStreams?: number;
        maxMessageSize?: number;
        maxObservedAddresses?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        runOnConnectionOpen?: boolean;
        runOnTransientConnection?: boolean;
        timeout?: number;
    }

    Properties

    agentVersion? +IdentifyInit | libp2p

    Interface IdentifyInit

    interface IdentifyInit {
        agentVersion?: string;
        maxInboundStreams?: number;
        maxMessageSize?: number;
        maxObservedAddresses?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        runOnConnectionOpen?: boolean;
        runOnTransientConnection?: boolean;
        timeout?: number;
    }

    Properties

    agentVersion? maxInboundStreams? maxMessageSize? maxObservedAddresses? @@ -8,28 +8,28 @@ runOnTransientConnection? timeout?

    Properties

    Optional agentVersion

    agentVersion?: string

    What details we should send as part of an identify message

    -

    Optional maxInboundStreams

    maxInboundStreams?: number

    The maximum number of inbound streams that may be open on a single +

    Optional maxInboundStreams

    maxInboundStreams?: number

    The maximum number of inbound streams that may be open on a single connection for this protocol

    Default

    1
    -

    Optional maxMessageSize

    maxMessageSize?: number

    Identify responses larger than this in bytes will be rejected

    +

    Optional maxMessageSize

    maxMessageSize?: number

    Identify responses larger than this in bytes will be rejected

    Default

    8192
    -

    Optional maxObservedAddresses

    maxObservedAddresses?: number

    The maximum number of observed addresses to send in an Identify message

    -

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    The maximum number of outbound streams that may be open on a single +

    Optional maxObservedAddresses

    maxObservedAddresses?: number

    The maximum number of observed addresses to send in an Identify message

    +

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    The maximum number of outbound streams that may be open on a single connection for this protocol

    Default

    1
    -

    Optional protocolPrefix

    protocolPrefix?: string

    The prefix to use for the protocol

    +

    Optional protocolPrefix

    protocolPrefix?: string

    The prefix to use for the protocol

    Default

    'ipfs'
    -

    Optional runOnConnectionOpen

    runOnConnectionOpen?: boolean

    Whether to automatically run identify on newly opened connections

    +

    Optional runOnConnectionOpen

    runOnConnectionOpen?: boolean

    Whether to automatically run identify on newly opened connections

    Default

    true
    -

    Optional runOnTransientConnection

    runOnTransientConnection?: boolean

    Whether to run on connections with data or duration limits

    +

    Optional runOnTransientConnection

    runOnTransientConnection?: boolean

    Whether to run on connections with data or duration limits

    Default

    true
    -

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send their identify response

    +

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send their identify response

    Default

    5000
    -

    Settings

    Member Visibility

    Theme

    On This Page

    agentVersionmaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnConnectionOpenrunOnTransientConnectiontimeout
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    agentVersionmaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnConnectionOpenrunOnTransientConnectiontimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPush.html b/interfaces/_libp2p_identify.IdentifyPush.html index def1e2db09..1afec1add1 100644 --- a/interfaces/_libp2p_identify.IdentifyPush.html +++ b/interfaces/_libp2p_identify.IdentifyPush.html @@ -1,2 +1,2 @@ -IdentifyPush | libp2p

    Interface IdentifyPush

    interface IdentifyPush {
        push(): Promise<void>;
    }

    Methods

    push -

    Methods

    push

    Settings

    Member Visibility

    Theme

    On This Page

    push
    \ No newline at end of file +IdentifyPush | libp2p

    Interface IdentifyPush

    interface IdentifyPush {
        push(): Promise<void>;
    }

    Methods

    push +

    Methods

    push

    Settings

    Member Visibility

    Theme

    On This Page

    push
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPushComponents.html b/interfaces/_libp2p_identify.IdentifyPushComponents.html index e00e49fc3a..ecfc97687a 100644 --- a/interfaces/_libp2p_identify.IdentifyPushComponents.html +++ b/interfaces/_libp2p_identify.IdentifyPushComponents.html @@ -1,4 +1,4 @@ -IdentifyPushComponents | libp2p

    Interface IdentifyPushComponents

    interface IdentifyPushComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        nodeInfo: NodeInfo;
        peerId: PeerId;
        peerStore: PeerStore;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    addressManager +IdentifyPushComponents | libp2p

    Interface IdentifyPushComponents

    interface IdentifyPushComponents {
        addressManager: AddressManager;
        connectionManager: ConnectionManager;
        events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
        logger: ComponentLogger;
        nodeInfo: NodeInfo;
        peerId: PeerId;
        peerStore: PeerStore;
        registrar: Registrar;
    }

    Hierarchy (view full)

    Properties

    addressManager connectionManager events logger @@ -6,4 +6,4 @@ peerId peerStore registrar -

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    nodeInfo

    nodeInfo: NodeInfo

    peerId

    peerId: PeerId

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagereventsloggernodeInfopeerIdpeerStoreregistrar
    \ No newline at end of file +

    Properties

    addressManager

    addressManager: AddressManager

    connectionManager

    connectionManager: ConnectionManager

    events

    events: TypedEventTarget<Libp2pEvents<ServiceMap>>

    logger

    logger: ComponentLogger

    nodeInfo

    nodeInfo: NodeInfo

    peerId

    peerId: PeerId

    peerStore

    peerStore: PeerStore

    registrar

    registrar: Registrar

    Settings

    Member Visibility

    Theme

    On This Page

    addressManagerconnectionManagereventsloggernodeInfopeerIdpeerStoreregistrar
    \ No newline at end of file diff --git a/interfaces/_libp2p_identify.IdentifyPushInit.html b/interfaces/_libp2p_identify.IdentifyPushInit.html index 35ae663012..03925546c9 100644 --- a/interfaces/_libp2p_identify.IdentifyPushInit.html +++ b/interfaces/_libp2p_identify.IdentifyPushInit.html @@ -1,4 +1,4 @@ -IdentifyPushInit | libp2p

    Interface IdentifyPushInit

    interface IdentifyPushInit {
        agentVersion?: string;
        concurrency?: number;
        maxInboundStreams?: number;
        maxMessageSize?: number;
        maxObservedAddresses?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        runOnSelfUpdate?: boolean;
        runOnTransientConnection?: boolean;
        timeout?: number;
    }

    Hierarchy

    Properties

    agentVersion? +IdentifyPushInit | libp2p

    Interface IdentifyPushInit

    interface IdentifyPushInit {
        agentVersion?: string;
        concurrency?: number;
        maxInboundStreams?: number;
        maxMessageSize?: number;
        maxObservedAddresses?: number;
        maxOutboundStreams?: number;
        protocolPrefix?: string;
        runOnSelfUpdate?: boolean;
        runOnTransientConnection?: boolean;
        timeout?: number;
    }

    Hierarchy

    Properties

    agentVersion? concurrency? maxInboundStreams? maxMessageSize? @@ -9,31 +9,31 @@ runOnTransientConnection? timeout?

    Properties

    Optional agentVersion

    agentVersion?: string

    What details we should send as part of an identify message

    -

    Optional concurrency

    concurrency?: number

    Push to this many connections in parallel

    +

    Optional concurrency

    concurrency?: number

    Push to this many connections in parallel

    Default

    32
    -

    Optional maxInboundStreams

    maxInboundStreams?: number

    The maximum number of inbound streams that may be open on a single +

    Optional maxInboundStreams

    maxInboundStreams?: number

    The maximum number of inbound streams that may be open on a single connection for this protocol

    Default

    1
    -

    Optional maxMessageSize

    maxMessageSize?: number

    Identify responses larger than this in bytes will be rejected

    +

    Optional maxMessageSize

    maxMessageSize?: number

    Identify responses larger than this in bytes will be rejected

    Default

    8192
    -

    Optional maxObservedAddresses

    maxObservedAddresses?: number

    The maximum number of observed addresses to send in an Identify message

    -

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    The maximum number of outbound streams that may be open on a single +

    Optional maxObservedAddresses

    maxObservedAddresses?: number

    The maximum number of observed addresses to send in an Identify message

    +

    Optional maxOutboundStreams

    maxOutboundStreams?: number

    The maximum number of outbound streams that may be open on a single connection for this protocol

    Default

    1
    -

    Optional protocolPrefix

    protocolPrefix?: string

    The prefix to use for the protocol

    +

    Optional protocolPrefix

    protocolPrefix?: string

    The prefix to use for the protocol

    Default

    'ipfs'
    -

    Optional runOnSelfUpdate

    runOnSelfUpdate?: boolean

    Whether to automatically dial identify-push on self updates

    +

    Optional runOnSelfUpdate

    runOnSelfUpdate?: boolean

    Whether to automatically dial identify-push on self updates

    Default

    true
    -

    Optional runOnTransientConnection

    runOnTransientConnection?: boolean

    Whether to run on connections with data or duration limits

    +

    Optional runOnTransientConnection

    runOnTransientConnection?: boolean

    Whether to run on connections with data or duration limits

    Default

    true
    -

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send their identify response

    +

    Optional timeout

    timeout?: number

    How long we should wait for a remote peer to send their identify response

    Default

    5000
    -

    Settings

    Member Visibility

    Theme

    On This Page

    agentVersionconcurrencymaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnSelfUpdaterunOnTransientConnectiontimeout
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    agentVersionconcurrencymaxInboundStreamsmaxMessageSizemaxObservedAddressesmaxOutboundStreamsprotocolPrefixrunOnSelfUpdaterunOnTransientConnectiontimeout
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.AbortOptions.html b/interfaces/_libp2p_interface.AbortOptions.html index 0bfb5870ab..aedf3de756 100644 --- a/interfaces/_libp2p_interface.AbortOptions.html +++ b/interfaces/_libp2p_interface.AbortOptions.html @@ -2,5 +2,5 @@ the optional signal property.

    Example

    const controller = new AbortController()

    aLongRunningOperation({
      signal: controller.signal
    })

    // later

    controller.abort()
    -
    interface AbortOptions {
        signal?: AbortSignal;
    }

    Hierarchy (view full)

    Properties

    signal? -

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    signal
    \ No newline at end of file +
    interface AbortOptions {
        signal?: AbortSignal;
    }

    Hierarchy (view full)

    Properties

    signal? +

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    signal
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Address.html b/interfaces/_libp2p_interface.Address.html index 055f44c3ca..5fc6e4a611 100644 --- a/interfaces/_libp2p_interface.Address.html +++ b/interfaces/_libp2p_interface.Address.html @@ -1,6 +1,6 @@ Address | libp2p

    Interface Address

    A multiaddr with an optional flag that indicates if its trustworthy

    -
    interface Address {
        isCertified: boolean;
        multiaddr: Multiaddr;
    }

    Properties

    isCertified +
    interface Address {
        isCertified: boolean;
        multiaddr: Multiaddr;
    }

    Properties

    isCertified multiaddr

    Properties

    isCertified

    isCertified: boolean

    Obtained from a signed peer record

    -

    multiaddr

    multiaddr: Multiaddr

    Peer multiaddr

    -

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedmultiaddr
    \ No newline at end of file +

    multiaddr

    multiaddr: Multiaddr

    Peer multiaddr

    +

    Settings

    Member Visibility

    Theme

    On This Page

    isCertifiedmultiaddr
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.AddressSorter.html b/interfaces/_libp2p_interface.AddressSorter.html index 4316b2dec2..3320c10c0c 100644 --- a/interfaces/_libp2p_interface.AddressSorter.html +++ b/interfaces/_libp2p_interface.AddressSorter.html @@ -1,2 +1,2 @@ AddressSorter | libp2p

    Interface AddressSorter

    Used by the connection manager to sort addresses into order before dialling

    -
    interface AddressSorter ((a, b) => -1 | 0 | 1)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface AddressSorter ((a, b) => -1 | 0 | 1)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CalculatedMetricOptions.html b/interfaces/_libp2p_interface.CalculatedMetricOptions.html index 187ab43000..6902bf42b0 100644 --- a/interfaces/_libp2p_interface.CalculatedMetricOptions.html +++ b/interfaces/_libp2p_interface.CalculatedMetricOptions.html @@ -1,10 +1,10 @@ CalculatedMetricOptions | libp2p

    Interface CalculatedMetricOptions<T>

    Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

    -
    interface CalculatedMetricOptions<T> {
        calculate: CalculateMetric<T>;
        help?: string;
        label?: string;
    }

    Type Parameters

    • T = number

    Hierarchy (view full)

    Properties

    calculate +
    interface CalculatedMetricOptions<T> {
        calculate: CalculateMetric<T>;
        help?: string;
        label?: string;
    }

    Type Parameters

    • T = number

    Hierarchy (view full)

    Properties

    calculate help? label?

    Properties

    calculate

    calculate: CalculateMetric<T>

    An optional function invoked to calculate the component metric instead of using .update, .increment, and .decrement

    -

    Optional help

    help?: string

    Optional help for the metric

    -

    Optional label

    label?: string

    Optional label for the metric

    -

    Settings

    Member Visibility

    Theme

    On This Page

    calculatehelplabel
    \ No newline at end of file +

    Optional help

    help?: string

    Optional help for the metric

    +

    Optional label

    label?: string

    Optional label for the metric

    +

    Settings

    Member Visibility

    Theme

    On This Page

    calculatehelplabel
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ComponentLogger.html b/interfaces/_libp2p_interface.ComponentLogger.html index 86a3d623da..f92d719ea6 100644 --- a/interfaces/_libp2p_interface.ComponentLogger.html +++ b/interfaces/_libp2p_interface.ComponentLogger.html @@ -1,3 +1,3 @@ ComponentLogger | libp2p

    Interface ComponentLogger

    Peer logger component for libp2p

    -
    interface ComponentLogger {
        forComponent(name): Logger;
    }

    Methods

    forComponent -

    Methods

    forComponent

    Settings

    Member Visibility

    Theme

    On This Page

    forComponent
    \ No newline at end of file +
    interface ComponentLogger {
        forComponent(name): Logger;
    }

    Methods

    forComponent +

    Methods

    forComponent

    Settings

    Member Visibility

    Theme

    On This Page

    forComponent
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Connection.html b/interfaces/_libp2p_interface.Connection.html index a9f6e1ba16..143b76d8b0 100644 --- a/interfaces/_libp2p_interface.Connection.html +++ b/interfaces/_libp2p_interface.Connection.html @@ -2,7 +2,7 @@ to a remote peer that may have been secured by encryption and multiplexed, depending on the configuration of the nodes between which the connection is made.

    -
    interface Connection {
        direction: Direction;
        encryption?: string;
        id: string;
        log: Logger;
        multiplexer?: string;
        remoteAddr: Multiaddr;
        remotePeer: PeerId;
        rtt?: number;
        status: ConnectionStatus;
        streams: Stream[];
        tags: string[];
        timeline: ConnectionTimeline;
        transient: boolean;
        abort(err): void;
        close(options?): Promise<void>;
        newStream(protocols, options?): Promise<Stream>;
    }

    Properties

    direction +
    interface Connection {
        direction: Direction;
        encryption?: string;
        id: string;
        log: Logger;
        multiplexer?: string;
        remoteAddr: Multiaddr;
        remotePeer: PeerId;
        rtt?: number;
        status: ConnectionStatus;
        streams: Stream[];
        tags: string[];
        timeline: ConnectionTimeline;
        transient: boolean;
        abort(err): void;
        close(options?): Promise<void>;
        newStream(protocols, options?): Promise<Stream>;
    }

    Properties

    direction encryption? id log @@ -19,24 +19,24 @@ close newStream

    Properties

    direction

    direction: Direction

    Outbound conections are opened by the local node, inbound streams are opened by the remote

    -

    Optional encryption

    encryption?: string

    The encryption protocol negotiated for this connection

    -

    id

    id: string

    The unique identifier for this connection

    -

    log

    log: Logger

    The connection logger

    -

    Optional multiplexer

    multiplexer?: string

    The multiplexer negotiated for this connection

    -

    remoteAddr

    remoteAddr: Multiaddr

    The address of the remote end of the connection

    -

    remotePeer

    remotePeer: PeerId

    The id of the peer at the remote end of the connection

    -

    Optional rtt

    rtt?: number

    The time in milliseconds it takes to make a round trip to the remote peer.

    +

    Optional encryption

    encryption?: string

    The encryption protocol negotiated for this connection

    +

    id

    id: string

    The unique identifier for this connection

    +

    log

    log: Logger

    The connection logger

    +

    Optional multiplexer

    multiplexer?: string

    The multiplexer negotiated for this connection

    +

    remoteAddr

    remoteAddr: Multiaddr

    The address of the remote end of the connection

    +

    remotePeer

    remotePeer: PeerId

    The id of the peer at the remote end of the connection

    +

    Optional rtt

    rtt?: number

    The time in milliseconds it takes to make a round trip to the remote peer.

    This is updated periodically by the connection monitor.

    -

    status

    status: ConnectionStatus

    The current status of the connection

    -

    streams

    streams: Stream[]

    A list of open streams on this connection

    -

    tags

    tags: string[]

    A list of tags applied to this connection

    -

    timeline

    timeline: ConnectionTimeline

    Lifecycle times for the connection

    -

    transient

    transient: boolean

    A transient connection is one that is not expected to be open for very long +

    status

    status: ConnectionStatus

    The current status of the connection

    +

    streams

    streams: Stream[]

    A list of open streams on this connection

    +

    tags

    tags: string[]

    A list of tags applied to this connection

    +

    timeline

    timeline: ConnectionTimeline

    Lifecycle times for the connection

    +

    transient

    transient: boolean

    A transient connection is one that is not expected to be open for very long or one that cannot transfer very much data, such as one being used as a circuit relay connection. Protocols need to explicitly opt-in to being run over transient connections.

    -

    Methods

    abort

    close

    Methods

    abort

    close

    newStream

    Settings

    Member Visibility

    Theme

    On This Page

    directionencryptionidlogmultiplexerremoteAddrremotePeerrttstatusstreamstagstimelinetransientabortclosenewStream
    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    newStream

    Settings

    Member Visibility

    Theme

    On This Page

    directionencryptionidlogmultiplexerremoteAddrremotePeerrttstatusstreamstagstimelinetransientabortclosenewStream
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionEncrypter.html b/interfaces/_libp2p_interface.ConnectionEncrypter.html index e3f1d13f1b..19d0700234 100644 --- a/interfaces/_libp2p_interface.ConnectionEncrypter.html +++ b/interfaces/_libp2p_interface.ConnectionEncrypter.html @@ -1,12 +1,12 @@ ConnectionEncrypter | libp2p

    Interface ConnectionEncrypter<Extension>

    A libp2p connection encrypter module must be compliant to this interface to ensure all exchanged data between two peers is encrypted.

    -
    interface ConnectionEncrypter<Extension> {
        protocol: string;
        secureInbound<Stream>(localPeer, connection, remotePeer?): Promise<SecuredConnection<Stream, Extension>>;
        secureOutbound<Stream>(localPeer, connection, remotePeer?): Promise<SecuredConnection<Stream, Extension>>;
    }

    Type Parameters

    • Extension = unknown

    Properties

    protocol +
    interface ConnectionEncrypter<Extension> {
        protocol: string;
        secureInbound<Stream>(localPeer, connection, remotePeer?): Promise<SecuredConnection<Stream, Extension>>;
        secureOutbound<Stream>(localPeer, connection, remotePeer?): Promise<SecuredConnection<Stream, Extension>>;
    }

    Type Parameters

    • Extension = unknown

    Properties

    protocol

    Methods

    secureInbound secureOutbound -

    Properties

    protocol

    protocol: string

    Methods

    secureInbound

    Properties

    protocol

    protocol: string

    Methods

    secureInbound

    secureOutbound

    secureOutbound

    Settings

    Member Visibility

    Theme

    On This Page

    protocolsecureInboundsecureOutbound
    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<SecuredConnection<Stream, Extension>>

    Settings

    Member Visibility

    Theme

    On This Page

    protocolsecureInboundsecureOutbound
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionGater.html b/interfaces/_libp2p_interface.ConnectionGater.html index 1915a54a66..cb65b7209b 100644 --- a/interfaces/_libp2p_interface.ConnectionGater.html +++ b/interfaces/_libp2p_interface.ConnectionGater.html @@ -1,4 +1,4 @@ -ConnectionGater | libp2p

    Interface ConnectionGater

    interface ConnectionGater {
        denyDialMultiaddr?(multiaddr): boolean | Promise<boolean>;
        denyDialPeer?(peerId): boolean | Promise<boolean>;
        denyInboundConnection?(maConn): boolean | Promise<boolean>;
        denyInboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyInboundRelayReservation?(source): boolean | Promise<boolean>;
        denyInboundRelayedConnection?(relay, remotePeer): boolean | Promise<boolean>;
        denyInboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundRelayedConnection?(source, destination): boolean | Promise<boolean>;
        denyOutboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
        filterMultiaddrForPeer?(peer, multiaddr): boolean | Promise<boolean>;
    }

    Methods

    denyDialMultiaddr? +ConnectionGater | libp2p

    Interface ConnectionGater

    interface ConnectionGater {
        denyDialMultiaddr?(multiaddr): boolean | Promise<boolean>;
        denyDialPeer?(peerId): boolean | Promise<boolean>;
        denyInboundConnection?(maConn): boolean | Promise<boolean>;
        denyInboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyInboundRelayReservation?(source): boolean | Promise<boolean>;
        denyInboundRelayedConnection?(relay, remotePeer): boolean | Promise<boolean>;
        denyInboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundEncryptedConnection?(peerId, maConn): boolean | Promise<boolean>;
        denyOutboundRelayedConnection?(source, destination): boolean | Promise<boolean>;
        denyOutboundUpgradedConnection?(peerId, maConn): boolean | Promise<boolean>;
        filterMultiaddrForPeer?(peer, multiaddr): boolean | Promise<boolean>;
    }

    Methods

    denyDialMultiaddr? denyDialPeer? denyInboundConnection? denyInboundEncryptedConnection? @@ -15,52 +15,52 @@

    This is called by the connection manager - if the peer id of the remote node is known it will be present in the multiaddr.

    Return true to prevent dialing the passed peer on the passed multiaddr.

    -

    Parameters

    Returns boolean | Promise<boolean>

    Optional denyDialPeer

    Optional denyDialPeer

    • denyDialPeer(peerId): boolean | Promise<boolean>

    • denyDialPeer tests whether we're permitted to Dial the specified peer.

      This is called by the dialer.connectToPeer implementation before dialling a peer.

      Return true to prevent dialing the passed peer.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyInboundConnection

    Optional denyInboundConnection

    • denyInboundConnection(maConn): boolean | Promise<boolean>

    • denyInboundConnection tests whether an incipient inbound connection is allowed.

      This is called by the upgrader, or by the transport directly (e.g. QUIC, Bluetooth), straight after it has accepted a connection from its socket.

      Return true to deny the incoming passed connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyInboundEncryptedConnection

    Optional denyInboundEncryptedConnection

    • denyInboundEncryptedConnection(peerId, maConn): boolean | Promise<boolean>

    • denyInboundEncryptedConnection tests whether a given connection, now encrypted, is allowed.

      This is called by the upgrader, after it has performed the security handshake, and before it negotiates the muxer, or by the directly by the transport, at the exact same checkpoint.

      Return true to deny the passed secured connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyInboundRelayReservation

    Optional denyInboundRelayReservation

    Optional denyInboundRelayedConnection

    Optional denyInboundRelayedConnection

    • denyInboundRelayedConnection(relay, remotePeer): boolean | Promise<boolean>

    • denyInboundRelayedConnection tests whether a remote peer is allowed to open a relayed connection to this node.

      This is invoked on the relay client when a remote relay has received an instruction to relay a connection to the client.

      Return true to deny the relayed connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyInboundUpgradedConnection

    Optional denyInboundUpgradedConnection

    • denyInboundUpgradedConnection(peerId, maConn): boolean | Promise<boolean>

    • denyInboundUpgradedConnection tests whether a fully capable connection is allowed.

      This is called after encryption has been negotiated and the connection has been multiplexed, if a multiplexer is configured.

      Return true to deny the passed upgraded connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyOutboundConnection

    Optional denyOutboundConnection

    • denyOutboundConnection(peerId, maConn): boolean | Promise<boolean>

    • denyOutboundConnection tests whether an incipient outbound connection is allowed.

      This is called by the upgrader, or by the transport directly (e.g. QUIC, Bluetooth), straight after it has created a connection with its socket.

      Return true to deny the incoming passed connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyOutboundEncryptedConnection

    Optional denyOutboundEncryptedConnection

    • denyOutboundEncryptedConnection(peerId, maConn): boolean | Promise<boolean>

    • denyOutboundEncryptedConnection tests whether a given connection, now encrypted, is allowed.

      This is called by the upgrader, after it has performed the security handshake, and before it negotiates the muxer, or by the directly by the transport, at the exact same checkpoint.

      Return true to deny the passed secured connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyOutboundRelayedConnection

    Optional denyOutboundRelayedConnection

    • denyOutboundRelayedConnection(source, destination): boolean | Promise<boolean>

    • denyOutboundRelayedConnection tests whether a remote peer is allowed to open a relayed connection to the destination node.

      This is invoked on the relay server when a source client with a reservation instructs the server to relay a connection to a destination peer.

      Return true to deny the relayed connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional denyOutboundUpgradedConnection

    Optional denyOutboundUpgradedConnection

    • denyOutboundUpgradedConnection(peerId, maConn): boolean | Promise<boolean>

    • denyOutboundUpgradedConnection tests whether a fully capable connection is allowed.

      This is called after encryption has been negotiated and the connection has been multiplexed, if a multiplexer is configured.

      Return true to deny the passed upgraded connection.

      -

      Parameters

      Returns boolean | Promise<boolean>

    Optional filterMultiaddrForPeer

    Optional filterMultiaddrForPeer

    Settings

    Member Visibility

    Theme

    On This Page

    denyDialMultiaddrdenyDialPeerdenyInboundConnectiondenyInboundEncryptedConnectiondenyInboundRelayReservationdenyInboundRelayedConnectiondenyInboundUpgradedConnectiondenyOutboundConnectiondenyOutboundEncryptedConnectiondenyOutboundRelayedConnectiondenyOutboundUpgradedConnectionfilterMultiaddrForPeer
    \ No newline at end of file +

    Parameters

    Returns boolean | Promise<boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    denyDialMultiaddrdenyDialPeerdenyInboundConnectiondenyInboundEncryptedConnectiondenyInboundRelayReservationdenyInboundRelayedConnectiondenyInboundUpgradedConnectiondenyOutboundConnectiondenyOutboundEncryptedConnectiondenyOutboundRelayedConnectiondenyOutboundUpgradedConnectionfilterMultiaddrForPeer
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionHandler.html b/interfaces/_libp2p_interface.ConnectionHandler.html index 80ee08b7b8..c6898ffd53 100644 --- a/interfaces/_libp2p_interface.ConnectionHandler.html +++ b/interfaces/_libp2p_interface.ConnectionHandler.html @@ -1 +1 @@ -ConnectionHandler | libp2p

    Interface ConnectionHandler

    interface ConnectionHandler ((connection) => void)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ConnectionHandler | libp2p

    Interface ConnectionHandler

    interface ConnectionHandler ((connection) => void)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionProtector.html b/interfaces/_libp2p_interface.ConnectionProtector.html index 0d35ba0054..8767dec035 100644 --- a/interfaces/_libp2p_interface.ConnectionProtector.html +++ b/interfaces/_libp2p_interface.ConnectionProtector.html @@ -1,5 +1,5 @@ -ConnectionProtector | libp2p

    Interface ConnectionProtector

    interface ConnectionProtector {
        protect(connection): Promise<MultiaddrConnection>;
    }

    Methods

    protect +ConnectionProtector | libp2p

    Interface ConnectionProtector

    interface ConnectionProtector {
        protect(connection): Promise<MultiaddrConnection>;
    }

    Methods

    protect

    Methods

    protect

    Settings

    Member Visibility

    Theme

    On This Page

    protect
    \ No newline at end of file +

    Parameters

    Returns Promise<MultiaddrConnection>

    Settings

    Member Visibility

    Theme

    On This Page

    protect
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ConnectionTimeline.html b/interfaces/_libp2p_interface.ConnectionTimeline.html index 0285d8d98a..3d959b5e94 100644 --- a/interfaces/_libp2p_interface.ConnectionTimeline.html +++ b/interfaces/_libp2p_interface.ConnectionTimeline.html @@ -1,8 +1,8 @@ -ConnectionTimeline | libp2p

    Interface ConnectionTimeline

    interface ConnectionTimeline {
        close?: number;
        open: number;
        upgraded?: number;
    }

    Properties

    close? +ConnectionTimeline | libp2p

    Interface ConnectionTimeline

    interface ConnectionTimeline {
        close?: number;
        open: number;
        upgraded?: number;
    }

    Properties

    close? open upgraded?

    Properties

    Optional close

    close?: number

    When the connection was closed.

    -

    open

    open: number

    When the connection was opened

    -

    Optional upgraded

    upgraded?: number

    When the MultiaddrConnection was upgraded to a Connection - e.g. the type +

    open

    open: number

    When the connection was opened

    +

    Optional upgraded

    upgraded?: number

    When the MultiaddrConnection was upgraded to a Connection - e.g. the type of connection encryption and multiplexing was negotiated.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    closeopenupgraded
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    closeopenupgraded
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ContentRouting.html b/interfaces/_libp2p_interface.ContentRouting.html index 3140527a71..45d0872695 100644 --- a/interfaces/_libp2p_interface.ContentRouting.html +++ b/interfaces/_libp2p_interface.ContentRouting.html @@ -1,19 +1,19 @@ -ContentRouting | libp2p

    Interface ContentRouting

    interface ContentRouting {
        findProviders(cid, options?): AsyncIterable<PeerInfo>;
        get(key, options?): Promise<Uint8Array>;
        provide(cid, options?): Promise<void>;
        put(key, value, options?): Promise<void>;
    }

    Methods

    findProviders +ContentRouting | libp2p

    Interface ContentRouting

    interface ContentRouting {
        findProviders(cid, options?): AsyncIterable<PeerInfo>;
        get(key, options?): Promise<Uint8Array>;
        provide(cid, options?): Promise<void>;
        put(key, value, options?): Promise<void>;
    }

    Methods

    findProviders get provide put

    Methods

    findProviders

    get

    get

    provide

    provide

    put

    put

    Settings

    Member Visibility

    Theme

    On This Page

    findProvidersgetprovideput
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    findProvidersgetprovideput
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ContentRoutingProvider.html b/interfaces/_libp2p_interface.ContentRoutingProvider.html index 6ac070228b..4ff25655eb 100644 --- a/interfaces/_libp2p_interface.ContentRoutingProvider.html +++ b/interfaces/_libp2p_interface.ContentRoutingProvider.html @@ -1,4 +1,4 @@ ContentRoutingProvider | libp2p

    Interface ContentRoutingProvider

    Implementers of this interface can provide a ContentRouting implementation to interested callers.

    -
    interface ContentRoutingProvider {
        [contentRoutingSymbol]: ContentRouting;
    }

    Properties

    [contentRoutingSymbol] -

    Properties

    [contentRoutingSymbol]

    [contentRoutingSymbol]: ContentRouting

    Settings

    Member Visibility

    Theme

    On This Page

    [contentRoutingSymbol]
    \ No newline at end of file +
    interface ContentRoutingProvider {
        [contentRoutingSymbol]: ContentRouting;
    }

    Properties

    [contentRoutingSymbol] +

    Properties

    [contentRoutingSymbol]

    [contentRoutingSymbol]: ContentRouting

    Settings

    Member Visibility

    Theme

    On This Page

    [contentRoutingSymbol]
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Counter.html b/interfaces/_libp2p_interface.Counter.html index aac8a8334a..81cadaeb77 100644 --- a/interfaces/_libp2p_interface.Counter.html +++ b/interfaces/_libp2p_interface.Counter.html @@ -1,7 +1,7 @@ Counter | libp2p

    Interface Counter

    A tracked counter loosely based on the Counter interface exposed by the prom-client module - counters are metrics that only go up

    -
    interface Counter {
        increment(value?): void;
        reset(): void;
    }

    Methods

    increment +
    interface Counter {
        increment(value?): void;
        reset(): void;
    }

    Methods

    increment reset

    Methods

    increment

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    incrementreset
    \ No newline at end of file +

    Parameters

    Returns void

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    incrementreset
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CounterGroup.html b/interfaces/_libp2p_interface.CounterGroup.html index 4f72d30a00..95b860c143 100644 --- a/interfaces/_libp2p_interface.CounterGroup.html +++ b/interfaces/_libp2p_interface.CounterGroup.html @@ -1,10 +1,10 @@ CounterGroup | libp2p

    Interface CounterGroup

    A group of tracked counters loosely based on the Counter interface exposed by the prom-client module - counters are metrics that only go up

    -
    interface CounterGroup {
        increment(values): void;
        reset(): void;
    }

    Methods

    increment +
    interface CounterGroup {
        increment(values): void;
        reset(): void;
    }

    Methods

    increment reset

    Methods

    increment

    reset

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    incrementreset
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    incrementreset
    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.CreateListenerOptions.html b/interfaces/_libp2p_interface.CreateListenerOptions.html index 4d9cb51a5d..03f3bdbeb1 100644 --- a/interfaces/_libp2p_interface.CreateListenerOptions.html +++ b/interfaces/_libp2p_interface.CreateListenerOptions.html @@ -1,3 +1,3 @@ -CreateListenerOptions | libp2p

    Interface CreateListenerOptions

    interface CreateListenerOptions {
        handler?: ConnectionHandler;
        upgrader: Upgrader;
    }

    Hierarchy

    • CreateListenerOptions

      Properties

      handler? +CreateListenerOptions | libp2p

      Interface CreateListenerOptions

      interface CreateListenerOptions {
          handler?: ConnectionHandler;
          upgrader: Upgrader;
      }

      Hierarchy

      • CreateListenerOptions

        Properties

        handler? upgrader -

        Properties

        Optional handler

        handler?: ConnectionHandler

        upgrader

        upgrader: Upgrader

        Settings

        Member Visibility

        Theme

        On This Page

        handlerupgrader
        \ No newline at end of file +

        Properties

        Optional handler

        handler?: ConnectionHandler

        upgrader

        upgrader: Upgrader

        Settings

        Member Visibility

        Theme

        On This Page

        handlerupgrader
        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialOptions.html b/interfaces/_libp2p_interface.DialOptions.html index 413ea3a19e..533d7a82e1 100644 --- a/interfaces/_libp2p_interface.DialOptions.html +++ b/interfaces/_libp2p_interface.DialOptions.html @@ -2,6 +2,6 @@ the optional signal property.

        Example

        const controller = new AbortController()

        aLongRunningOperation({
          signal: controller.signal
        })

        // later

        controller.abort()
        -
        interface DialOptions {
            onProgress?: ((evt) => void);
            signal?: AbortSignal;
        }

        Hierarchy (view full)

        Properties

        onProgress? +
        interface DialOptions {
            onProgress?: ((evt) => void);
            signal?: AbortSignal;
        }

        Hierarchy (view full)

        Properties

        onProgress? signal? -

        Properties

        Optional onProgress

        onProgress?: ((evt) => void)

        Type declaration

          • (evt): void

          • Parameters

            • evt: any

            Returns void

        Optional signal

        signal?: AbortSignal

        Settings

        Member Visibility

        Theme

        On This Page

        onProgresssignal
        \ No newline at end of file +

        Properties

        Optional onProgress

        onProgress?: ((evt) => void)

        Type declaration

          • (evt): void

          • Parameters

            • evt: any

            Returns void

        Optional signal

        signal?: AbortSignal

        Settings

        Member Visibility

        Theme

        On This Page

        onProgresssignal
        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialProtocolOptions.html b/interfaces/_libp2p_interface.DialProtocolOptions.html index 6c548ec7d8..5dd1ab4207 100644 --- a/interfaces/_libp2p_interface.DialProtocolOptions.html +++ b/interfaces/_libp2p_interface.DialProtocolOptions.html @@ -2,14 +2,14 @@ the optional signal property.

        Example

        const controller = new AbortController()

        aLongRunningOperation({
          signal: controller.signal
        })

        // later

        controller.abort()
        -
        interface DialProtocolOptions {
            maxOutboundStreams?: number;
            negotiateFully?: boolean;
            runOnTransientConnection?: boolean;
            signal?: AbortSignal;
        }

        Hierarchy (view full)

        Properties

        maxOutboundStreams? +
        interface DialProtocolOptions {
            maxOutboundStreams?: number;
            negotiateFully?: boolean;
            runOnTransientConnection?: boolean;
            signal?: AbortSignal;
        }

        Hierarchy (view full)

        Properties

        maxOutboundStreams? negotiateFully? runOnTransientConnection? signal?

        Properties

        Optional maxOutboundStreams

        maxOutboundStreams?: number

        If specified, and no handler has been registered with the registrar for the successfully negotiated protocol, use this as the max outbound stream limit for the protocol

        -

        Optional negotiateFully

        negotiateFully?: boolean

        By default when negotiating a protocol the dialer writes then protocol name +

        Optional negotiateFully

        negotiateFully?: boolean

        By default when negotiating a protocol the dialer writes then protocol name then reads the response.

        When a only a single protocol is being negotiated on an outbound stream, and the stream is written to before being read from, we can optimistically @@ -27,8 +27,8 @@ in full before the stream is returned so this option has no effect.

        Default

        true
        -

        Optional runOnTransientConnection

        runOnTransientConnection?: boolean

        Opt-in to running over a transient connection - one that has time/data limits +

        Optional runOnTransientConnection

        runOnTransientConnection?: boolean

        Opt-in to running over a transient connection - one that has time/data limits placed on it.

        Default

        false
        -

        Optional signal

        signal?: AbortSignal

        Settings

        Member Visibility

        Theme

        On This Page

        maxOutboundStreamsnegotiateFullyrunOnTransientConnectionsignal
        \ No newline at end of file +

        Optional signal

        signal?: AbortSignal

        Settings

        Member Visibility

        Theme

        On This Page

        maxOutboundStreamsnegotiateFullyrunOnTransientConnectionsignal
        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.DialTransportOptions.html b/interfaces/_libp2p_interface.DialTransportOptions.html index f7e6356233..8bb79e8e2a 100644 --- a/interfaces/_libp2p_interface.DialTransportOptions.html +++ b/interfaces/_libp2p_interface.DialTransportOptions.html @@ -2,7 +2,7 @@ the optional signal property.

        Example

        const controller = new AbortController()

        aLongRunningOperation({
          signal: controller.signal
        })

        // later

        controller.abort()
        -
        interface DialTransportOptions<DialEvents> {
            onProgress?: ((evt) => void);
            signal?: AbortSignal;
            upgrader: Upgrader;
        }

        Type Parameters

        Hierarchy (view full)

        Properties

        onProgress? +
        interface DialTransportOptions<DialEvents> {
            onProgress?: ((evt) => void);
            signal?: AbortSignal;
            upgrader: Upgrader;
        }

        Type Parameters

        Hierarchy (view full)

        Properties

        onProgress? signal? upgrader -

        Properties

        Optional onProgress

        onProgress?: ((evt) => void)

        Type declaration

        Optional signal

        signal?: AbortSignal

        upgrader

        upgrader: Upgrader

        Settings

        Member Visibility

        Theme

        On This Page

        onProgresssignalupgrader
        \ No newline at end of file +

        Properties

        Optional onProgress

        onProgress?: ((evt) => void)

        Type declaration

        Optional signal

        signal?: AbortSignal

        upgrader

        upgrader: Upgrader

        Settings

        Member Visibility

        Theme

        On This Page

        onProgresssignalupgrader
        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Ed25519PeerId.html b/interfaces/_libp2p_interface.Ed25519PeerId.html index 757f92ff26..3cb3584a76 100644 --- a/interfaces/_libp2p_interface.Ed25519PeerId.html +++ b/interfaces/_libp2p_interface.Ed25519PeerId.html @@ -1,4 +1,4 @@ -Ed25519PeerId | libp2p

        Interface Ed25519PeerId

        interface Ed25519PeerId {
            multihash: MultihashDigest<number>;
            privateKey?: Uint8Array;
            publicKey: Uint8Array;
            type: "Ed25519";
            equals(other?): boolean;
            toBytes(): Uint8Array;
            toCID(): CID<unknown, number, number, Version>;
            toString(): string;
        }

        Hierarchy (view full)

        Properties

        multihash +Ed25519PeerId | libp2p

        Interface Ed25519PeerId

        interface Ed25519PeerId {
            multihash: MultihashDigest<number>;
            privateKey?: Uint8Array;
            publicKey: Uint8Array;
            type: "Ed25519";
            equals(other?): boolean;
            toBytes(): Uint8Array;
            toCID(): CID<unknown, number, number, Version>;
            toString(): string;
        }

        Hierarchy (view full)

        Properties

        multihash privateKey? publicKey type @@ -6,4 +6,4 @@ toBytes toCID toString -

        Properties

        multihash

        multihash: MultihashDigest<number>

        Optional privateKey

        privateKey?: Uint8Array

        Readonly publicKey

        publicKey: Uint8Array

        Readonly type

        type: "Ed25519"

        Methods

        equals

        toBytes

        toCID

        toString

        Settings

        Member Visibility

        Theme

        On This Page

        multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
        \ No newline at end of file +

        Properties

        multihash

        multihash: MultihashDigest<number>

        Optional privateKey

        privateKey?: Uint8Array

        Readonly publicKey

        publicKey: Uint8Array

        Readonly type

        type: "Ed25519"

        Methods

        equals

        toBytes

        toCID

        toString

        Settings

        Member Visibility

        Theme

        On This Page

        multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Envelope.html b/interfaces/_libp2p_interface.Envelope.html index 1e63d43ecd..b5ebe2066c 100644 --- a/interfaces/_libp2p_interface.Envelope.html +++ b/interfaces/_libp2p_interface.Envelope.html @@ -1,8 +1,8 @@ -Envelope | libp2p

        Interface Envelope

        interface Envelope {
            payload: Uint8Array;
            payloadType: Uint8Array | Uint8ArrayList;
            peerId: PeerId;
            signature: Uint8Array | Uint8ArrayList;
            equals(other): boolean;
            marshal(): Uint8Array;
            validate(domain): Promise<boolean>;
        }

        Implemented by

          Properties

          payload +Envelope | libp2p

          Interface Envelope

          interface Envelope {
              payload: Uint8Array;
              payloadType: Uint8Array | Uint8ArrayList;
              peerId: PeerId;
              signature: Uint8Array | Uint8ArrayList;
              equals(other): boolean;
              marshal(): Uint8Array;
              validate(domain): Promise<boolean>;
          }

          Implemented by

            Properties

            payload payloadType peerId signature

            Methods

            equals marshal validate -

            Properties

            payload

            payload: Uint8Array

            payloadType

            payloadType: Uint8Array | Uint8ArrayList

            peerId

            peerId: PeerId

            signature

            signature: Uint8Array | Uint8ArrayList

            Methods

            equals

            marshal

            validate

            Settings

            Member Visibility

            Theme

            On This Page

            payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
            \ No newline at end of file +

            Properties

            payload

            payload: Uint8Array

            payloadType

            payloadType: Uint8Array | Uint8ArrayList

            peerId

            peerId: PeerId

            signature

            signature: Uint8Array | Uint8ArrayList

            Methods

            equals

            marshal

            validate

            Settings

            Member Visibility

            Theme

            On This Page

            payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.EventCallback.html b/interfaces/_libp2p_interface.EventCallback.html index 4c28b94add..064bcf66ef 100644 --- a/interfaces/_libp2p_interface.EventCallback.html +++ b/interfaces/_libp2p_interface.EventCallback.html @@ -1 +1 @@ -EventCallback | libp2p

            Interface EventCallback<EventType>

            interface EventCallback<EventType> ((evt) => void)

            Type Parameters

            • EventType

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +EventCallback | libp2p

            Interface EventCallback<EventType>

            interface EventCallback<EventType> ((evt) => void)

            Type Parameters

            • EventType

            Settings

            Member Visibility

            Theme

            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.EventObject.html b/interfaces/_libp2p_interface.EventObject.html index 2e9de17389..f314825e33 100644 --- a/interfaces/_libp2p_interface.EventObject.html +++ b/interfaces/_libp2p_interface.EventObject.html @@ -1,2 +1,2 @@ -EventObject | libp2p

            Interface EventObject<EventType>

            interface EventObject<EventType> {
                handleEvent: EventCallback<EventType>;
            }

            Type Parameters

            • EventType

            Properties

            handleEvent -

            Properties

            handleEvent

            handleEvent: EventCallback<EventType>

            Settings

            Member Visibility

            Theme

            On This Page

            handleEvent
            \ No newline at end of file +EventObject | libp2p

            Interface EventObject<EventType>

            interface EventObject<EventType> {
                handleEvent: EventCallback<EventType>;
            }

            Type Parameters

            • EventType

            Properties

            handleEvent +

            Properties

            handleEvent

            handleEvent: EventCallback<EventType>

            Settings

            Member Visibility

            Theme

            On This Page

            handleEvent
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IdentifyResult.html b/interfaces/_libp2p_interface.IdentifyResult.html index d40a827ec9..5946dea7b6 100644 --- a/interfaces/_libp2p_interface.IdentifyResult.html +++ b/interfaces/_libp2p_interface.IdentifyResult.html @@ -1,5 +1,5 @@ IdentifyResult | libp2p

            Interface IdentifyResult

            Data returned from a successful identify response

            -
            interface IdentifyResult {
                agentVersion?: string;
                connection: Connection;
                listenAddrs: Multiaddr[];
                observedAddr?: Multiaddr;
                peerId: PeerId;
                protocolVersion?: string;
                protocols: string[];
                publicKey?: Uint8Array;
                signedPeerRecord?: SignedPeerRecord;
            }

            Properties

            agentVersion? +
            interface IdentifyResult {
                agentVersion?: string;
                connection: Connection;
                listenAddrs: Multiaddr[];
                observedAddr?: Multiaddr;
                peerId: PeerId;
                protocolVersion?: string;
                protocols: string[];
                publicKey?: Uint8Array;
                signedPeerRecord?: SignedPeerRecord;
            }

            Properties

            agentVersion? connection listenAddrs observedAddr? @@ -9,16 +9,16 @@ publicKey? signedPeerRecord?

            Properties

            Optional agentVersion

            agentVersion?: string

            The remote agent version

            -

            connection

            connection: Connection

            The connection that the identify protocol ran over

            -

            listenAddrs

            listenAddrs: Multiaddr[]

            The unsigned addresses they are listening on. Note - any multiaddrs present +

            connection

            connection: Connection

            The connection that the identify protocol ran over

            +

            listenAddrs

            listenAddrs: Multiaddr[]

            The unsigned addresses they are listening on. Note - any multiaddrs present in the signed peer record should be preferred to the value here.

            -

            Optional observedAddr

            observedAddr?: Multiaddr

            If set this is the address that the remote peer saw the identify request +

            Optional observedAddr

            observedAddr?: Multiaddr

            If set this is the address that the remote peer saw the identify request originate from

            -

            peerId

            peerId: PeerId

            The remote Peer's PeerId

            -

            Optional protocolVersion

            protocolVersion?: string

            The remote protocol version

            -

            protocols

            protocols: string[]

            The protocols the remote peer supports

            -

            Optional publicKey

            publicKey?: Uint8Array

            The public key part of the remote PeerId - this is only useful for older +

            peerId

            peerId: PeerId

            The remote Peer's PeerId

            +

            Optional protocolVersion

            protocolVersion?: string

            The remote protocol version

            +

            protocols

            protocols: string[]

            The protocols the remote peer supports

            +

            Optional publicKey

            publicKey?: Uint8Array

            The public key part of the remote PeerId - this is only useful for older RSA-based PeerIds, the more modern Ed25519 and secp256k1 types have the public key embedded in them

            -

            Optional signedPeerRecord

            signedPeerRecord?: SignedPeerRecord

            If sent by the remote peer this is the deserialized signed peer record

            -

            Settings

            Member Visibility

            Theme

            On This Page

            agentVersionconnectionlistenAddrsobservedAddrpeerIdprotocolVersionprotocolspublicKeysignedPeerRecord
            \ No newline at end of file +

            Optional signedPeerRecord

            signedPeerRecord?: SignedPeerRecord

            If sent by the remote peer this is the deserialized signed peer record

            +

            Settings

            Member Visibility

            Theme

            On This Page

            agentVersionconnectionlistenAddrsobservedAddrpeerIdprotocolVersionprotocolspublicKeysignedPeerRecord
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IncomingStreamData.html b/interfaces/_libp2p_interface.IncomingStreamData.html index 3e78073ab9..9e3435c915 100644 --- a/interfaces/_libp2p_interface.IncomingStreamData.html +++ b/interfaces/_libp2p_interface.IncomingStreamData.html @@ -1,3 +1,3 @@ -IncomingStreamData | libp2p

            Interface IncomingStreamData

            interface IncomingStreamData {
                connection: Connection;
                stream: Stream;
            }

            Properties

            connection +IncomingStreamData | libp2p

            Interface IncomingStreamData

            interface IncomingStreamData {
                connection: Connection;
                stream: Stream;
            }

            Properties

            connection stream -

            Properties

            connection

            connection: Connection

            stream

            stream: Stream

            Settings

            Member Visibility

            Theme

            On This Page

            connectionstream
            \ No newline at end of file +

            Properties

            connection

            connection: Connection

            stream

            stream: Stream

            Settings

            Member Visibility

            Theme

            On This Page

            connectionstream
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.IsDialableOptions.html b/interfaces/_libp2p_interface.IsDialableOptions.html index cc6e088970..de04316d7a 100644 --- a/interfaces/_libp2p_interface.IsDialableOptions.html +++ b/interfaces/_libp2p_interface.IsDialableOptions.html @@ -2,10 +2,10 @@ the optional signal property.

            Example

            const controller = new AbortController()

            aLongRunningOperation({
              signal: controller.signal
            })

            // later

            controller.abort()
            -
            interface IsDialableOptions {
                runOnTransientConnection?: boolean;
                signal?: AbortSignal;
            }

            Hierarchy (view full)

            Properties

            runOnTransientConnection? +
            interface IsDialableOptions {
                runOnTransientConnection?: boolean;
                signal?: AbortSignal;
            }

            Hierarchy (view full)

            Properties

            runOnTransientConnection? signal?

            Properties

            Optional runOnTransientConnection

            runOnTransientConnection?: boolean

            If the dial attempt would open a protocol, and the multiaddr being dialed is a circuit relay address, passing true here would cause the test to fail because that protocol would not be allowed to run over a data/time limited connection.

            -

            Optional signal

            signal?: AbortSignal

            Settings

            Member Visibility

            Theme

            On This Page

            runOnTransientConnectionsignal
            \ No newline at end of file +

            Optional signal

            signal?: AbortSignal

            Settings

            Member Visibility

            Theme

            On This Page

            runOnTransientConnectionsignal
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Libp2p.html b/interfaces/_libp2p_interface.Libp2p.html index 437ce01f22..cd24f7da92 100644 --- a/interfaces/_libp2p_interface.Libp2p.html +++ b/interfaces/_libp2p_interface.Libp2p.html @@ -1,5 +1,5 @@ Libp2p | libp2p

            Interface Libp2p<T>

            Libp2p nodes implement this interface.

            -
            interface Libp2p<T> {
                contentRouting: ContentRouting;
                logger: ComponentLogger;
                metrics?: Metrics;
                peerId: PeerId;
                peerRouting: PeerRouting;
                peerStore: PeerStore;
                services: T;
                status: Libp2pStatus;
                addEventListener<K>(type, listener, options?): void;
                afterStart?(): void | Promise<void>;
                afterStop?(): void | Promise<void>;
                beforeStart?(): void | Promise<void>;
                beforeStop?(): void | Promise<void>;
                dial(peer, options?): Promise<Connection>;
                dialProtocol(peer, protocols, options?): Promise<Stream>;
                dispatchEvent(event): boolean;
                dispatchEvent(event): boolean;
                getConnections(peerId?): Connection[];
                getDialQueue(): PendingDial[];
                getMultiaddrs(): Multiaddr[];
                getPeers(): PeerId[];
                getProtocols(): string[];
                getPublicKey(peer, options?): Promise<Uint8Array>;
                handle(protocol, handler, options?): Promise<void>;
                hangUp(peer, options?): Promise<void>;
                isDialable(multiaddr, options?): Promise<boolean>;
                listenerCount(type): number;
                register(protocol, topology): Promise<string>;
                removeEventListener<K>(type, listener?, options?): void;
                removeEventListener(type, listener?, options?): void;
                safeDispatchEvent<Detail>(type, detail): boolean;
                start(): void | Promise<void>;
                stop(): void | Promise<void>;
                unhandle(protocols): Promise<void>;
                unregister(id): void;
            }

            Type Parameters

            Hierarchy (view full)

            Properties

            contentRouting +
            interface Libp2p<T> {
                contentRouting: ContentRouting;
                logger: ComponentLogger;
                metrics?: Metrics;
                peerId: PeerId;
                peerRouting: PeerRouting;
                peerStore: PeerStore;
                services: T;
                status: Libp2pStatus;
                addEventListener<K>(type, listener, options?): void;
                afterStart?(): void | Promise<void>;
                afterStop?(): void | Promise<void>;
                beforeStart?(): void | Promise<void>;
                beforeStop?(): void | Promise<void>;
                dial(peer, options?): Promise<Connection>;
                dialProtocol(peer, protocols, options?): Promise<Stream>;
                dispatchEvent(event): boolean;
                dispatchEvent(event): boolean;
                getConnections(peerId?): Connection[];
                getDialQueue(): PendingDial[];
                getMultiaddrs(): Multiaddr[];
                getPeers(): PeerId[];
                getProtocols(): string[];
                getPublicKey(peer, options?): Promise<Uint8Array>;
                handle(protocol, handler, options?): Promise<void>;
                hangUp(peer, options?): Promise<void>;
                isDialable(multiaddr, options?): Promise<boolean>;
                listenerCount(type): number;
                register(protocol, topology): Promise<string>;
                removeEventListener<K>(type, listener?, options?): void;
                removeEventListener(type, listener?, options?): void;
                safeDispatchEvent<Detail>(type, detail): boolean;
                start(): void | Promise<void>;
                stop(): void | Promise<void>;
                unhandle(protocols): Promise<void>;
                unregister(id): void;
            }

            Type Parameters

            Hierarchy (view full)

            Properties

            contentRouting logger metrics? peerId @@ -37,49 +37,49 @@ the DHT.

            Example

            for await (const peerInfo of libp2p.contentRouting.findProviders(cid)) {
              console.info(peerInfo)
              // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
            }
            -

            logger

            logger: ComponentLogger

            The logger used by this libp2p node

            -

            Optional metrics

            metrics?: Metrics

            The metrics subsystem allows recording values to assess the health/performance +

            logger

            logger: ComponentLogger

            The logger used by this libp2p node

            +

            Optional metrics

            metrics?: Metrics

            The metrics subsystem allows recording values to assess the health/performance of the running node.

            Example

            const metric = libp2p.metrics.registerMetric({
              'my-metric'
            })

            // later
            metric.update(5)
            -

            peerId

            peerId: PeerId

            The PeerId is a unique identifier for a node on the network.

            +

            peerId

            peerId: PeerId

            The PeerId is a unique identifier for a node on the network.

            It is the hash of an RSA public key or, for Ed25519 or secp256k1 keys, the key itself.

            Example

            console.info(libp2p.peerId)
            // PeerId(12D3Foo...)
            -

            peerRouting

            peerRouting: PeerRouting

            The peer routing subsystem allows the user to find peers on the network +

            peerRouting

            peerRouting: PeerRouting

            The peer routing subsystem allows the user to find peers on the network or to find peers close to binary keys.

            Example

            const peerInfo = await libp2p.peerRouting.findPeer(peerId)
            console.info(peerInfo)
            // { id: PeerId(12D3Foo...), multiaddrs: [] ... }

            Example

            for await (const peerInfo of libp2p.peerRouting.getClosestPeers(key)) {
              console.info(peerInfo)
              // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
            }
            -

            peerStore

            peerStore: PeerStore

            The peer store holds information we know about other peers on the network.

            +

            peerStore

            peerStore: PeerStore

            The peer store holds information we know about other peers on the network.

            • multiaddrs, supported protocols, etc.

            Example

            const peer = await libp2p.peerStore.get(peerId)
            console.info(peer)
            // { id: PeerId(12D3Foo...), addresses: [] ... }
            -

            services

            services: T

            A set of user defined services

            -

            status

            status: Libp2pStatus

            The current status of the libp2p node

            -

            Methods

            addEventListener

            Optional afterStart

            services

            services: T

            A set of user defined services

            +

            status

            status: Libp2pStatus

            The current status of the libp2p node

            +

            Methods

            addEventListener

            Optional afterStart

            Optional afterStop

            Optional afterStop

            Optional beforeStart

            Optional beforeStart

            Optional beforeStop

            Optional beforeStop

            dial

            dial

            • dial(peer, options?): Promise<Connection>

            • Dials to the provided peer. If successful, the known metadata of the peer will be added to the nodes peerStore.

              If a PeerId is passed as the first argument, the peer will need to have known multiaddrs for it in the PeerStore.

              Parameters

              Returns Promise<Connection>

              Example

              const conn = await libp2p.dial(remotePeerId)

              // create a new stream within the connection
              const stream = await conn.newStream(['/echo/1.1.0', '/echo/1.0.0'])

              // protocol negotiated: 'echo/1.0.0' means that the other party only supports the older version

              // ...
              await conn.close()
              -

            dialProtocol

            dialProtocol

            • dialProtocol(peer, protocols, options?): Promise<Stream>

            • 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 MuxedStream will be returned together with the successful negotiated protocol.

              Parameters

              Returns Promise<Stream>

              Example

              import { pipe } from 'it-pipe'

              const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)

              // Use this new stream like any other duplex stream
              pipe([1, 2, 3], stream, consume)
              -

            dispatchEvent

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              +

            dispatchEvent

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              MDN Reference

              Parameters

              Returns boolean

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              MDN Reference

              @@ -87,53 +87,53 @@

              Example

              for

              Parameters

              Returns Connection[]

              Example

              for (const connection of libp2p.getConnections()) {
                console.log(peerId, connection.remoteAddr.toString())
                // Logs the PeerId string and the observed remote multiaddr of each Connection
              }
              -

            getDialQueue

            getDialQueue

            getMultiaddrs

            getMultiaddrs

            • getMultiaddrs(): Multiaddr[]

            • Get a deduplicated list of peer advertising multiaddrs by concatenating the listen addresses used by transports with any configured announce addresses as well as observed addresses reported by peers.

              If Announce addrs are specified, configured listen addresses will be ignored though observed addresses will still be included.

              Returns Multiaddr[]

              Example

              const listenMa = libp2p.getMultiaddrs()
              // [ <Multiaddr 047f00000106f9ba - /ip4/127.0.0.1/tcp/63930> ]
              -

            getPeers

            getProtocols

            getPeers

            getProtocols

            • getProtocols(): string[]

            • Returns a list of supported protocols

              Returns string[]

              Example

              const protocols = libp2p.getProtocols()
              // [ '/ipfs/ping/1.0.0', '/ipfs/id/1.0.0' ]
              -

            getPublicKey

            getPublicKey

            handle

            handle

            • handle(protocol, handler, options?): Promise<void>

            • Sets up multistream-select routing of protocols to their application handlers. Whenever a stream is opened on one of the provided protocols, the handler will be called. handle must be called in order to register a handler and support for a given protocol. This also informs other peers of the protocols you support.

              libp2p.handle(protocols, handler, options)

              In the event of a new handler for the same protocol being added, the first one is discarded.

              Parameters

              Returns Promise<void>

              Example

              const handler = ({ connection, stream, protocol }) => {
                // use stream or connection according to the needs
              }

              libp2p.handle('/echo/1.0.0', handler, {
                maxInboundStreams: 5,
                maxOutboundStreams: 5
              })
              -

            hangUp

            hangUp

            • hangUp(peer, options?): Promise<void>

            • Attempts to gracefully close an open connection to the given peer. If the connection is not closed in the grace period, it will be forcefully closed.

              An AbortSignal can optionally be passed to control when the connection is forcefully closed.

              Parameters

              Returns Promise<void>

              Example

              await libp2p.hangUp(remotePeerId)
              -

            isDialable

            isDialable

            • isDialable(multiaddr, options?): Promise<boolean>

            • Given the current node configuration, returns a promise of true or false if the node would attempt to dial the passed multiaddr.

              This means a relevant transport is configured, and the connection gater would not block the dial attempt.

              This may involve resolving DNS addresses so you should pass an AbortSignal.

              -

              Parameters

              Returns Promise<boolean>

            listenerCount

            register

            listenerCount

            register

            • register(protocol, topology): Promise<string>

            • Register a topology to be informed when peers are encountered that support the specified protocol

              Parameters

              Returns Promise<string>

              Example

              const id = await libp2p.register('/echo/1.0.0', {
                onConnect: (peer, connection) => {
                  // handle connect
                },
                onDisconnect: (peer, connection) => {
                  // handle disconnect
                }
              })
              -

            removeEventListener

            safeDispatchEvent

            start

            removeEventListener

            safeDispatchEvent

            start

            stop

            stop

            unhandle

            unhandle

            • unhandle(protocols): Promise<void>

            • Removes the handler for each protocol. The protocol will no longer be supported on streams.

              Parameters

              • protocols: string | string[]

              Returns Promise<void>

              Example

              libp2p.unhandle(['/echo/1.0.0'])
              -

            unregister

            unregister

            • unregister(id): void

            • Unregister topology to no longer be informed when peers connect or disconnect.

              Parameters

              • id: string

              Returns void

              Example

              const id = await libp2p.register(...)

              libp2p.unregister(id)
              -

            Settings

            Member Visibility

            Theme

            On This Page

            contentRoutingloggermetricspeerIdpeerRoutingpeerStoreservicesstatusaddEventListenerafterStartafterStopbeforeStartbeforeStopdialdialProtocoldispatchEventgetConnectionsgetDialQueuegetMultiaddrsgetPeersgetProtocolsgetPublicKeyhandlehangUpisDialablelistenerCountregisterremoveEventListenersafeDispatchEventstartstopunhandleunregister
            \ No newline at end of file +

            Settings

            Member Visibility

            Theme

            On This Page

            contentRoutingloggermetricspeerIdpeerRoutingpeerStoreservicesstatusaddEventListenerafterStartafterStopbeforeStartbeforeStopdialdialProtocoldispatchEventgetConnectionsgetDialQueuegetMultiaddrsgetPeersgetProtocolsgetPublicKeyhandlehangUpisDialablelistenerCountregisterremoveEventListenersafeDispatchEventstartstopunhandleunregister
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Libp2pEvents.html b/interfaces/_libp2p_interface.Libp2pEvents.html index 656171c42e..50b16ec63d 100644 --- a/interfaces/_libp2p_interface.Libp2pEvents.html +++ b/interfaces/_libp2p_interface.Libp2pEvents.html @@ -2,7 +2,7 @@ so that you can be notified of relevant network events.

            Event names are noun:verb so the first part is the name of the object being acted on and the second is the action.

            -
            interface Libp2pEvents<T> {
                connection:close: CustomEvent<Connection>;
                connection:open: CustomEvent<Connection>;
                connection:prune: CustomEvent<Connection[]>;
                peer:connect: CustomEvent<PeerId>;
                peer:disconnect: CustomEvent<PeerId>;
                peer:discovery: CustomEvent<PeerInfo>;
                peer:identify: CustomEvent<IdentifyResult>;
                peer:update: CustomEvent<PeerUpdate>;
                self:peer:update: CustomEvent<PeerUpdate>;
                start: CustomEvent<Libp2p<T>>;
                stop: CustomEvent<Libp2p<T>>;
                transport:close: CustomEvent<Listener>;
                transport:listening: CustomEvent<Listener>;
            }

            Type Parameters

            Properties

            connection:close +
            interface Libp2pEvents<T> {
                connection:close: CustomEvent<Connection>;
                connection:open: CustomEvent<Connection>;
                connection:prune: CustomEvent<Connection[]>;
                peer:connect: CustomEvent<PeerId>;
                peer:disconnect: CustomEvent<PeerId>;
                peer:discovery: CustomEvent<PeerInfo>;
                peer:identify: CustomEvent<IdentifyResult>;
                peer:update: CustomEvent<PeerUpdate>;
                self:peer:update: CustomEvent<PeerUpdate>;
                start: CustomEvent<Libp2p<T>>;
                stop: CustomEvent<Libp2p<T>>;
                transport:close: CustomEvent<Listener>;
                transport:listening: CustomEvent<Listener>;
            }

            Type Parameters

            Properties

            connection:close connection:open connection:prune peer:connect @@ -17,44 +17,44 @@ transport:listening

            Properties

            connection:close

            connection:close: CustomEvent<Connection>

            This event notifies listeners when incoming or outgoing connections are closed.

            -

            connection:open

            connection:open: CustomEvent<Connection>

            This event notifies listeners when new incoming or outgoing connections +

            connection:open

            connection:open: CustomEvent<Connection>

            This event notifies listeners when new incoming or outgoing connections are opened.

            -

            connection:prune

            connection:prune: CustomEvent<Connection[]>

            This event is dispatched when the connection manager has more than the +

            connection:prune

            connection:prune: CustomEvent<Connection[]>

            This event is dispatched when the connection manager has more than the configured allowable max connections and has closed some connections to bring the node back under the limit.

            -

            peer:connect

            peer:connect: CustomEvent<PeerId>

            This event will be triggered any time a new peer connects.

            +

            peer:connect

            peer:connect: CustomEvent<PeerId>

            This event will be triggered any time a new peer connects.

            Example

            libp2p.addEventListener('peer:connect', (event) => {
              const peerId = event.detail
              // ...
            })
            -

            peer:disconnect

            peer:disconnect: CustomEvent<PeerId>

            This event will be triggered any time we are disconnected from another peer, regardless of +

            peer:disconnect

            peer:disconnect: CustomEvent<PeerId>

            This event will be triggered any time we are disconnected from another peer, regardless of the circumstances of that disconnection. If we happen to have multiple connections to a peer, this event will only be triggered when the last connection is closed.

            Example

            libp2p.addEventListener('peer:disconnect', (event) => {
              const peerId = event.detail
              // ...
            })
            -

            peer:discovery

            peer:discovery: CustomEvent<PeerInfo>

            This event is dispatched when a new network peer is discovered.

            +

            peer:discovery

            peer:discovery: CustomEvent<PeerInfo>

            This event is dispatched when a new network peer is discovered.

            Example

            libp2p.addEventListener('peer:discovery', (event) => {
               const peerInfo = event.detail
               // ...
            })
            -

            peer:identify

            peer:identify: CustomEvent<IdentifyResult>

            This event is dispatched after a remote peer has successfully responded to the identify +

            peer:identify

            peer:identify: CustomEvent<IdentifyResult>

            This event is dispatched after a remote peer has successfully responded to the identify protocol. Note that for this to be emitted, both peers must have an identify service configured.

            Example

            libp2p.addEventListener('peer:identify', (event) => {
              const identifyResult = event.detail
              // ...
            })
            -

            peer:update

            peer:update: CustomEvent<PeerUpdate>

            This event is dispatched when the peer store data for a peer has been +

            peer:update

            peer:update: CustomEvent<PeerUpdate>

            This event is dispatched when the peer store data for a peer has been updated - e.g. their multiaddrs, protocols etc have changed.

            If they were previously known to this node, the old peer data will be set in the previous field.

            This may be in response to the identify protocol running, a manual update or some other event.

            -

            self:peer:update

            self:peer:update: CustomEvent<PeerUpdate>

            This event is dispatched when the current node's peer record changes - +

            self:peer:update

            self:peer:update: CustomEvent<PeerUpdate>

            This event is dispatched when the current node's peer record changes - for example a transport started listening on a new address or a new protocol handler was registered.

            Example

            libp2p.addEventListener('self:peer:update', (event) => {
              const { peer } = event.detail
              // ...
            })
            -

            start

            start: CustomEvent<Libp2p<T>>

            This event notifies listeners that the node has started

            +

            start

            start: CustomEvent<Libp2p<T>>

            This event notifies listeners that the node has started

            libp2p.addEventListener('start', (event) => {
              console.info(libp2p.isStarted()) // true
            })
            -

            stop

            stop: CustomEvent<Libp2p<T>>

            This event notifies listeners that the node has stopped

            +

            stop

            stop: CustomEvent<Libp2p<T>>

            This event notifies listeners that the node has stopped

            libp2p.addEventListener('stop', (event) => {
              console.info(libp2p.isStarted()) // false
            })
            -

            transport:close

            transport:close: CustomEvent<Listener>

            This event is dispatched when a transport stops listening on an address

            -

            transport:listening

            transport:listening: CustomEvent<Listener>

            This event is dispatched when a transport begins listening on a new address

            -

            Settings

            Member Visibility

            Theme

            On This Page

            connection:closeconnection:openconnection:prunepeer:connectpeer:disconnectpeer:discoverypeer:identifypeer:updateself:peer:updatestartstoptransport:closetransport:listening
            \ No newline at end of file +

            transport:close

            transport:close: CustomEvent<Listener>

            This event is dispatched when a transport stops listening on an address

            +

            transport:listening

            transport:listening: CustomEvent<Listener>

            This event is dispatched when a transport begins listening on a new address

            +

            Settings

            Member Visibility

            Theme

            On This Page

            connection:closeconnection:openconnection:prunepeer:connectpeer:disconnectpeer:discoverypeer:identifypeer:updateself:peer:updatestartstoptransport:closetransport:listening
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Listener.html b/interfaces/_libp2p_interface.Listener.html index 43682c8001..3116df26e9 100644 --- a/interfaces/_libp2p_interface.Listener.html +++ b/interfaces/_libp2p_interface.Listener.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

            -
            interface Listener {
                addEventListener<K>(type, listener, options?): void;
                close(): Promise<void>;
                dispatchEvent(event): boolean;
                dispatchEvent(event): boolean;
                getAddrs(): Multiaddr[];
                listen(multiaddr): Promise<void>;
                listenerCount(type): number;
                removeEventListener<K>(type, listener?, options?): void;
                removeEventListener(type, listener?, options?): void;
                safeDispatchEvent<Detail>(type, detail): boolean;
            }

            Hierarchy (view full)

            Methods

            addEventListener +
            interface Listener {
                addEventListener<K>(type, listener, options?): void;
                close(): Promise<void>;
                dispatchEvent(event): boolean;
                dispatchEvent(event): boolean;
                getAddrs(): Multiaddr[];
                listen(multiaddr): Promise<void>;
                listenerCount(type): number;
                removeEventListener<K>(type, listener?, options?): void;
                removeEventListener(type, listener?, options?): void;
                safeDispatchEvent<Detail>(type, detail): boolean;
            }

            Hierarchy (view full)

            Methods

            addEventListener close dispatchEvent getAddrs @@ -11,11 +11,11 @@ listenerCount removeEventListener safeDispatchEvent -

            Methods

            addEventListener

            close

            dispatchEvent

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              +

            Methods

            addEventListener

            close

            dispatchEvent

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              MDN Reference

              Parameters

              Returns boolean

            • dispatchEvent(event): boolean

            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

              MDN Reference

              Parameters

              Returns boolean

            getAddrs

            listen

            listenerCount

            removeEventListener

            safeDispatchEvent

            Settings

            Member Visibility

            Theme

            On This Page

            addEventListenerclosedispatchEventgetAddrslistenlistenerCountremoveEventListenersafeDispatchEvent
            \ No newline at end of file +

            Returns Multiaddr[]

            listen

            listenerCount

            removeEventListener

            safeDispatchEvent

            Settings

            Member Visibility

            Theme

            On This Page

            addEventListenerclosedispatchEventgetAddrslistenlistenerCountremoveEventListenersafeDispatchEvent
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.ListenerEvents.html b/interfaces/_libp2p_interface.ListenerEvents.html index 90ebfcf71d..20ecb82316 100644 --- a/interfaces/_libp2p_interface.ListenerEvents.html +++ b/interfaces/_libp2p_interface.ListenerEvents.html @@ -1,5 +1,5 @@ -ListenerEvents | libp2p

            Interface ListenerEvents

            interface ListenerEvents {
                close: CustomEvent<any>;
                connection: CustomEvent<Connection>;
                error: CustomEvent<Error>;
                listening: CustomEvent<any>;
            }

            Properties

            close +ListenerEvents | libp2p

            Interface ListenerEvents

            interface ListenerEvents {
                close: CustomEvent<any>;
                connection: CustomEvent<Connection>;
                error: CustomEvent<Error>;
                listening: CustomEvent<any>;
            }

            Properties

            close connection error listening -

            Properties

            close

            close: CustomEvent<any>

            connection

            connection: CustomEvent<Connection>

            error

            error: CustomEvent<Error>

            listening

            listening: CustomEvent<any>

            Settings

            Member Visibility

            Theme

            On This Page

            closeconnectionerrorlistening
            \ No newline at end of file +

            Properties

            close

            close: CustomEvent<any>

            connection

            connection: CustomEvent<Connection>

            error

            error: CustomEvent<Error>

            listening

            listening: CustomEvent<any>

            Settings

            Member Visibility

            Theme

            On This Page

            closeconnectionerrorlistening
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Logger.html b/interfaces/_libp2p_interface.Logger.html index 869192acbc..28502e6216 100644 --- a/interfaces/_libp2p_interface.Logger.html +++ b/interfaces/_libp2p_interface.Logger.html @@ -1,5 +1,5 @@ Logger | libp2p

            Interface Logger

            Logger component for libp2p

            -
            interface Logger {
                enabled: boolean;
                error(formatter, ...args): void;
                trace(formatter, ...args): void;
                (formatter, ...args): void;
            }

            Properties

            enabled +
            interface Logger {
                enabled: boolean;
                error(formatter, ...args): void;
                trace(formatter, ...args): void;
                (formatter, ...args): void;
            }

            Properties

            enabled

            Methods

            error trace -

            Properties

            enabled

            enabled: boolean

            Methods

            error

            trace

            Settings

            Member Visibility

            Theme

            On This Page

            enablederrortrace
            \ No newline at end of file +

            Properties

            enabled

            enabled: boolean

            Methods

            error

            trace

            Settings

            Member Visibility

            Theme

            On This Page

            enablederrortrace
            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.LoggerOptions.html b/interfaces/_libp2p_interface.LoggerOptions.html index 7790b62151..0e53789e6f 100644 --- a/interfaces/_libp2p_interface.LoggerOptions.html +++ b/interfaces/_libp2p_interface.LoggerOptions.html @@ -1,3 +1,3 @@ LoggerOptions | libp2p

            Interface LoggerOptions

            An object that contains a Logger as the log property.

            -
            interface LoggerOptions {
                log: Logger;
            }

            Hierarchy

            • LoggerOptions

              Properties

              log -

              Properties

              log

              log: Logger

              Settings

              Member Visibility

              Theme

              On This Page

              log
              \ No newline at end of file +
              interface LoggerOptions {
                  log: Logger;
              }

              Hierarchy

              • LoggerOptions

                Properties

                log +

                Properties

                log

                log: Logger

                Settings

                Member Visibility

                Theme

                On This Page

                log
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Metric.html b/interfaces/_libp2p_interface.Metric.html index 0c3cc6da9f..967e783aec 100644 --- a/interfaces/_libp2p_interface.Metric.html +++ b/interfaces/_libp2p_interface.Metric.html @@ -1,14 +1,14 @@ Metric | libp2p

                Interface Metric

                A tracked metric loosely based on the interfaces exposed by the prom-client module

                -
                interface Metric {
                    decrement(value?): void;
                    increment(value?): void;
                    reset(): void;
                    timer(): StopTimer;
                    update(value): void;
                }

                Methods

                decrement +
                interface Metric {
                    decrement(value?): void;
                    increment(value?): void;
                    reset(): void;
                    timer(): StopTimer;
                    update(value): void;
                }

                Methods

                decrement increment reset timer update

                Methods

                decrement

                increment

                reset

                timer

                increment

                reset

                timer

                update

                Settings

                Member Visibility

                Theme

                On This Page

                decrementincrementresettimerupdate
                \ No newline at end of file +

                Returns StopTimer

                update

                Settings

                Member Visibility

                Theme

                On This Page

                decrementincrementresettimerupdate
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MetricGroup.html b/interfaces/_libp2p_interface.MetricGroup.html index f5f43983bb..b49aac54ea 100644 --- a/interfaces/_libp2p_interface.MetricGroup.html +++ b/interfaces/_libp2p_interface.MetricGroup.html @@ -1,17 +1,17 @@ MetricGroup | libp2p

                Interface MetricGroup

                A group of related metrics loosely based on the interfaces exposed by the prom-client module

                -
                interface MetricGroup {
                    decrement(values): void;
                    increment(values): void;
                    reset(): void;
                    timer(key): StopTimer;
                    update(values): void;
                }

                Methods

                decrement +
                interface MetricGroup {
                    decrement(values): void;
                    increment(values): void;
                    reset(): void;
                    timer(key): StopTimer;
                    update(values): void;
                }

                Methods

                decrement increment reset timer update

                Methods

                decrement

                increment

                increment

                reset

                reset

                timer

                timer

                update

                Settings

                Member Visibility

                Theme

                On This Page

                decrementincrementresettimerupdate
                \ No newline at end of file +

                Parameters

                • key: string

                Returns StopTimer

                update

                Settings

                Member Visibility

                Theme

                On This Page

                decrementincrementresettimerupdate
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MetricOptions.html b/interfaces/_libp2p_interface.MetricOptions.html index 50bce79b7a..01e8d43dc5 100644 --- a/interfaces/_libp2p_interface.MetricOptions.html +++ b/interfaces/_libp2p_interface.MetricOptions.html @@ -1,7 +1,7 @@ MetricOptions | libp2p

                Interface MetricOptions

                Create tracked metrics with these options. Loosely based on the interfaces exposed by the prom-client module

                -
                interface MetricOptions {
                    help?: string;
                    label?: string;
                }

                Hierarchy (view full)

                Properties

                help? +
                interface MetricOptions {
                    help?: string;
                    label?: string;
                }

                Hierarchy (view full)

                Properties

                help? label?

                Properties

                Optional help

                help?: string

                Optional help for the metric

                -

                Optional label

                label?: string

                Optional label for the metric

                -

                Settings

                Member Visibility

                Theme

                On This Page

                helplabel
                \ No newline at end of file +

                Optional label

                label?: string

                Optional label for the metric

                +

                Settings

                Member Visibility

                Theme

                On This Page

                helplabel
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Metrics.html b/interfaces/_libp2p_interface.Metrics.html index b036f6d014..ab5457dc60 100644 --- a/interfaces/_libp2p_interface.Metrics.html +++ b/interfaces/_libp2p_interface.Metrics.html @@ -16,7 +16,7 @@

                Example: How to track multiaddr connections

                This is something only li

                Example: How to track protocol streams

                This is something only libp2p connections need to do.

                import { Metrics } from '@libp2p/interface/metrics'

                interface MyServiceComponents {
                  metrics: Metrics
                }

                class MyService {
                  private readonly metrics: Metrics

                  constructor (components: MyServiceComponents) {
                    this.metrics = components.metrics
                  }

                  // later
                  doSomething () {
                    const stream = {} // create a stream
                    this.metrics.trackProtocolStream(stream)
                  }
                }
                -
                interface Metrics {
                    registerCounter: ((name, options?) => Counter) & ((name, options) => void);
                    registerCounterGroup: ((name, options?) => CounterGroup) & ((name, options) => void);
                    registerMetric: ((name, options?) => Metric) & ((name, options) => void);
                    registerMetricGroup: ((name, options?) => MetricGroup) & ((name, options) => void);
                    trackMultiaddrConnection(maConn): void;
                    trackProtocolStream(stream, connection): void;
                }

                Properties

                registerCounter +
                interface Metrics {
                    registerCounter: ((name, options?) => Counter) & ((name, options) => void);
                    registerCounterGroup: ((name, options?) => CounterGroup) & ((name, options) => void);
                    registerMetric: ((name, options?) => Metric) & ((name, options) => void);
                    registerMetricGroup: ((name, options?) => MetricGroup) & ((name, options) => void);
                    trackMultiaddrConnection(maConn): void;
                    trackProtocolStream(stream, connection): void;
                }

                Properties

                registerCounter registerCounterGroup registerMetric registerMetricGroup @@ -24,15 +24,15 @@

                Example: How to track protocol streams

                This is something only libp2p trackProtocolStream

                Properties

                registerCounter

                registerCounter: ((name, options?) => Counter) & ((name, options) => void)

                Register an arbitrary counter. Call this to set help/labels for counters and increment them by calling methods on the returned counter object

                -

                Type declaration

                Type declaration

                registerCounterGroup

                registerCounterGroup: ((name, options?) => CounterGroup) & ((name, options) => void)

                Register a a group of related counters. Call this to set help/labels for +

                Type declaration

                Type declaration

                registerCounterGroup

                registerCounterGroup: ((name, options?) => CounterGroup) & ((name, options) => void)

                Register a a group of related counters. Call this to set help/labels for groups of related counters that will be updated with by calling the .increment method on the returned counter group object

                -

                Type declaration

                Type declaration

                registerMetric

                registerMetric: ((name, options?) => Metric) & ((name, options) => void)

                Register an arbitrary metric. Call this to set help/labels for metrics +

                Type declaration

                Type declaration

                registerMetric

                registerMetric: ((name, options?) => Metric) & ((name, options) => void)

                Register an arbitrary metric. Call this to set help/labels for metrics and update/increment/decrement/etc them by calling methods on the returned metric object

                -

                Type declaration

                Type declaration

                registerMetricGroup

                registerMetricGroup: ((name, options?) => MetricGroup) & ((name, options) => void)

                Register a a group of related metrics. Call this to set help/labels for +

                Type declaration

                Type declaration

                registerMetricGroup

                registerMetricGroup: ((name, options?) => MetricGroup) & ((name, options) => void)

                Register a a group of related metrics. Call this to set help/labels for groups of related metrics that will be updated with by calling .update, .increment and/or .decrement methods on the returned metric group object

                -

                Type declaration

                Type declaration

                Methods

                trackMultiaddrConnection

                trackProtocolStream

                Settings

                Member Visibility

                Theme

                On This Page

                registerCounterregisterCounterGroupregisterMetricregisterMetricGrouptrackMultiaddrConnectiontrackProtocolStream
                \ No newline at end of file +

                Type declaration

                Type declaration

                Methods

                trackMultiaddrConnection

                trackProtocolStream

                Settings

                Member Visibility

                Theme

                On This Page

                registerCounterregisterCounterGroupregisterMetricregisterMetricGrouptrackMultiaddrConnectiontrackProtocolStream
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrConnection.html b/interfaces/_libp2p_interface.MultiaddrConnection.html index 104576c146..535e080dd1 100644 --- a/interfaces/_libp2p_interface.MultiaddrConnection.html +++ b/interfaces/_libp2p_interface.MultiaddrConnection.html @@ -1,7 +1,7 @@ MultiaddrConnection | libp2p

                Interface MultiaddrConnection

                A MultiaddrConnection is returned by transports after dialing a peer. It is a low-level primitive and is the raw connection without encryption or stream multiplexing.

                -
                interface MultiaddrConnection {
                    log: Logger;
                    remoteAddr: Multiaddr;
                    sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                    source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                    timeline: MultiaddrConnectionTimeline;
                    abort(err): void;
                    close(options?): Promise<void>;
                }

                Hierarchy

                Properties

                log +
                interface MultiaddrConnection {
                    log: Logger;
                    remoteAddr: Multiaddr;
                    sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                    source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                    timeline: MultiaddrConnectionTimeline;
                    abort(err): void;
                    close(options?): Promise<void>;
                }

                Hierarchy

                Properties

                log remoteAddr sink source @@ -9,9 +9,9 @@

                Methods

                abort close

                Properties

                log

                log: Logger

                The multiaddr connection logger

                -

                remoteAddr

                remoteAddr: Multiaddr

                The address of the remote end of the connection

                -

                sink

                sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                source

                source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                timeline

                timeline: MultiaddrConnectionTimeline

                When connection lifecycle events occurred

                -

                Methods

                abort

                close

                remoteAddr

                remoteAddr: Multiaddr

                The address of the remote end of the connection

                +

                sink

                sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                source

                source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                timeline

                timeline: MultiaddrConnectionTimeline

                When connection lifecycle events occurred

                +

                Methods

                abort

                close

                Settings

                Member Visibility

                Theme

                On This Page

                logremoteAddrsinksourcetimelineabortclose
                \ No newline at end of file +

                Parameters

                Returns Promise<void>

                Settings

                Member Visibility

                Theme

                On This Page

                logremoteAddrsinksourcetimelineabortclose
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html b/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html index a37e3fd053..261e6d3ef0 100644 --- a/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html +++ b/interfaces/_libp2p_interface.MultiaddrConnectionTimeline.html @@ -1,8 +1,8 @@ -MultiaddrConnectionTimeline | libp2p

                Interface MultiaddrConnectionTimeline

                interface MultiaddrConnectionTimeline {
                    close?: number;
                    open: number;
                    upgraded?: number;
                }

                Properties

                close? +MultiaddrConnectionTimeline | libp2p

                Interface MultiaddrConnectionTimeline

                interface MultiaddrConnectionTimeline {
                    close?: number;
                    open: number;
                    upgraded?: number;
                }

                Properties

                close? open upgraded?

                Properties

                Optional close

                close?: number

                When the connection was closed.

                -

                open

                open: number

                When the connection was opened

                -

                Optional upgraded

                upgraded?: number

                When the MultiaddrConnection was upgraded to a Connection - the type of +

                open

                open: number

                When the connection was opened

                +

                Optional upgraded

                upgraded?: number

                When the MultiaddrConnection was upgraded to a Connection - the type of connection encryption and multiplexing was negotiated.

                -

                Settings

                Member Visibility

                Theme

                On This Page

                closeopenupgraded
                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                closeopenupgraded
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.MultiaddrFilter.html b/interfaces/_libp2p_interface.MultiaddrFilter.html index d155218b8e..abdb07166e 100644 --- a/interfaces/_libp2p_interface.MultiaddrFilter.html +++ b/interfaces/_libp2p_interface.MultiaddrFilter.html @@ -1 +1 @@ -MultiaddrFilter | libp2p

                Interface MultiaddrFilter

                interface MultiaddrFilter ((multiaddrs) => Multiaddr[])

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +MultiaddrFilter | libp2p

                Interface MultiaddrFilter

                interface MultiaddrFilter ((multiaddrs) => Multiaddr[])

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.NewStreamOptions.html b/interfaces/_libp2p_interface.NewStreamOptions.html index 20573a6c1c..51078558a9 100644 --- a/interfaces/_libp2p_interface.NewStreamOptions.html +++ b/interfaces/_libp2p_interface.NewStreamOptions.html @@ -2,14 +2,14 @@ the optional signal property.

                Example

                const controller = new AbortController()

                aLongRunningOperation({
                  signal: controller.signal
                })

                // later

                controller.abort()
                -
                interface NewStreamOptions {
                    maxOutboundStreams?: number;
                    negotiateFully?: boolean;
                    runOnTransientConnection?: boolean;
                    signal?: AbortSignal;
                }

                Hierarchy (view full)

                Properties

                maxOutboundStreams? +
                interface NewStreamOptions {
                    maxOutboundStreams?: number;
                    negotiateFully?: boolean;
                    runOnTransientConnection?: boolean;
                    signal?: AbortSignal;
                }

                Hierarchy (view full)

                Properties

                maxOutboundStreams? negotiateFully? runOnTransientConnection? signal?

                Properties

                Optional maxOutboundStreams

                maxOutboundStreams?: number

                If specified, and no handler has been registered with the registrar for the successfully negotiated protocol, use this as the max outbound stream limit for the protocol

                -

                Optional negotiateFully

                negotiateFully?: boolean

                By default when negotiating a protocol the dialer writes then protocol name +

                Optional negotiateFully

                negotiateFully?: boolean

                By default when negotiating a protocol the dialer writes then protocol name then reads the response.

                When a only a single protocol is being negotiated on an outbound stream, and the stream is written to before being read from, we can optimistically @@ -27,8 +27,8 @@ in full before the stream is returned so this option has no effect.

                Default

                true
                -

                Optional runOnTransientConnection

                runOnTransientConnection?: boolean

                Opt-in to running over a transient connection - one that has time/data limits +

                Optional runOnTransientConnection

                runOnTransientConnection?: boolean

                Opt-in to running over a transient connection - one that has time/data limits placed on it.

                Default

                false
                -

                Optional signal

                signal?: AbortSignal

                Settings

                Member Visibility

                Theme

                On This Page

                maxOutboundStreamsnegotiateFullyrunOnTransientConnectionsignal
                \ No newline at end of file +

                Optional signal

                signal?: AbortSignal

                Settings

                Member Visibility

                Theme

                On This Page

                maxOutboundStreamsnegotiateFullyrunOnTransientConnectionsignal
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.NodeInfo.html b/interfaces/_libp2p_interface.NodeInfo.html index f3d91d0336..a4d3617887 100644 --- a/interfaces/_libp2p_interface.NodeInfo.html +++ b/interfaces/_libp2p_interface.NodeInfo.html @@ -1,6 +1,6 @@ NodeInfo | libp2p

                Interface NodeInfo

                Metadata about the current node

                -
                interface NodeInfo {
                    name: string;
                    version: string;
                }

                Properties

                name +
                interface NodeInfo {
                    name: string;
                    version: string;
                }

                Properties

                name version

                Properties

                name

                name: string

                The implementation name

                -

                version

                version: string

                The implementation version

                -

                Settings

                Member Visibility

                Theme

                On This Page

                nameversion
                \ No newline at end of file +

                version

                version: string

                The implementation version

                +

                Settings

                Member Visibility

                Theme

                On This Page

                nameversion
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Peer.html b/interfaces/_libp2p_interface.Peer.html index 713883ff64..a5b6fe588c 100644 --- a/interfaces/_libp2p_interface.Peer.html +++ b/interfaces/_libp2p_interface.Peer.html @@ -1,5 +1,5 @@ Peer | libp2p

                Interface Peer

                Data stored in the peer store about peers

                -
                interface Peer {
                    addresses: Address[];
                    id: PeerId;
                    metadata: Map<string, Uint8Array>;
                    peerRecordEnvelope?: Uint8Array;
                    protocols: string[];
                    tags: Map<string, Tag>;
                }

                Properties

                addresses +
                interface Peer {
                    addresses: Address[];
                    id: PeerId;
                    metadata: Map<string, Uint8Array>;
                    peerRecordEnvelope?: Uint8Array;
                    protocols: string[];
                    tags: Map<string, Tag>;
                }

                Properties

                addresses id metadata peerRecordEnvelope? @@ -7,9 +7,9 @@ tags

                Properties

                addresses

                addresses: Address[]

                Peer's addresses containing a list of multiaddrs and a isCertified field indicating if the address was loaded from a signed peer record or not

                -

                id

                id: PeerId

                Peer's peer-id instance

                -

                metadata

                metadata: Map<string, Uint8Array>

                Peer's metadata map

                -

                Optional peerRecordEnvelope

                peerRecordEnvelope?: Uint8Array

                The last peer record envelope received

                -

                protocols

                protocols: string[]

                Peer's supported protocols

                -

                tags

                tags: Map<string, Tag>

                Tags a peer has

                -

                Settings

                Member Visibility

                Theme

                On This Page

                addressesidmetadatapeerRecordEnvelopeprotocolstags
                \ No newline at end of file +

                id

                id: PeerId

                Peer's peer-id instance

                +

                metadata

                metadata: Map<string, Uint8Array>

                Peer's metadata map

                +

                Optional peerRecordEnvelope

                peerRecordEnvelope?: Uint8Array

                The last peer record envelope received

                +

                protocols

                protocols: string[]

                Peer's supported protocols

                +

                tags

                tags: Map<string, Tag>

                Tags a peer has

                +

                Settings

                Member Visibility

                Theme

                On This Page

                addressesidmetadatapeerRecordEnvelopeprotocolstags
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerData.html b/interfaces/_libp2p_interface.PeerData.html index 6dd7047c1f..0df789c62e 100644 --- a/interfaces/_libp2p_interface.PeerData.html +++ b/interfaces/_libp2p_interface.PeerData.html @@ -1,5 +1,5 @@ PeerData | libp2p

                Interface PeerData

                Peer data used to update the peer store

                -
                interface PeerData {
                    addresses?: Address[];
                    metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>;
                    multiaddrs?: Multiaddr[];
                    peerRecordEnvelope?: Uint8Array;
                    protocols?: string[];
                    publicKey?: Uint8Array;
                    tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>;
                }

                Properties

                addresses? +
                interface PeerData {
                    addresses?: Address[];
                    metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>;
                    multiaddrs?: Multiaddr[];
                    peerRecordEnvelope?: Uint8Array;
                    protocols?: string[];
                    publicKey?: Uint8Array;
                    tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>;
                }

                Properties

                addresses? metadata? multiaddrs? peerRecordEnvelope? @@ -11,13 +11,13 @@ set to true.

                If both addresses and multiaddrs are specified they will be merged together with entries in addresses taking precedence.

                -

                Optional metadata

                metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>

                Peer's metadata map. When merging pass undefined as values to remove metadata.

                -

                Optional multiaddrs

                multiaddrs?: Multiaddr[]

                Peer's multiaddrs - any multiaddrs passed here will be treated as +

                Optional metadata

                metadata?: Map<string, undefined | Uint8Array> | Record<string, undefined | Uint8Array>

                Peer's metadata map. When merging pass undefined as values to remove metadata.

                +

                Optional multiaddrs

                multiaddrs?: Multiaddr[]

                Peer's multiaddrs - any multiaddrs passed here will be treated as uncertified.

                If both addresses and multiaddrs are specified they will be merged together with entries in addresses taking precedence.

                -

                Optional peerRecordEnvelope

                peerRecordEnvelope?: Uint8Array

                The last peer record envelope received

                -

                Optional protocols

                protocols?: string[]

                Peer's supported protocols

                -

                Optional publicKey

                publicKey?: Uint8Array

                If this Peer has an RSA key, it's public key can be set with this property

                -

                Optional tags

                tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>

                Peer tags. When merging pass undefined as values to remove tags.

                -

                Settings

                Member Visibility

                Theme

                On This Page

                addressesmetadatamultiaddrspeerRecordEnvelopeprotocolspublicKeytags
                \ No newline at end of file +

                Optional peerRecordEnvelope

                peerRecordEnvelope?: Uint8Array

                The last peer record envelope received

                +

                Optional protocols

                protocols?: string[]

                Peer's supported protocols

                +

                Optional publicKey

                publicKey?: Uint8Array

                If this Peer has an RSA key, it's public key can be set with this property

                +

                Optional tags

                tags?: Map<string, undefined | TagOptions> | Record<string, undefined | TagOptions>

                Peer tags. When merging pass undefined as values to remove tags.

                +

                Settings

                Member Visibility

                Theme

                On This Page

                addressesmetadatamultiaddrspeerRecordEnvelopeprotocolspublicKeytags
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscovery.html b/interfaces/_libp2p_interface.PeerDiscovery.html index ce9213aec3..11ffd2527d 100644 --- a/interfaces/_libp2p_interface.PeerDiscovery.html +++ b/interfaces/_libp2p_interface.PeerDiscovery.html @@ -3,13 +3,13 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                -
                interface PeerDiscovery {
                    addEventListener<K>(type, listener, options?): void;
                    dispatchEvent(event): boolean;
                    dispatchEvent(event): boolean;
                    listenerCount(type): number;
                    removeEventListener<K>(type, listener?, options?): void;
                    removeEventListener(type, listener?, options?): void;
                    safeDispatchEvent<Detail>(type, detail): boolean;
                }

                Hierarchy (view full)

                Methods

                addEventListener +
                interface PeerDiscovery {
                    addEventListener<K>(type, listener, options?): void;
                    dispatchEvent(event): boolean;
                    dispatchEvent(event): boolean;
                    listenerCount(type): number;
                    removeEventListener<K>(type, listener?, options?): void;
                    removeEventListener(type, listener?, options?): void;
                    safeDispatchEvent<Detail>(type, detail): boolean;
                }

                Hierarchy (view full)

                Methods

                addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

                Methods

                addEventListener

                dispatchEvent

                • dispatchEvent(event): boolean

                • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                  +

                Methods

                addEventListener

                dispatchEvent

                • dispatchEvent(event): boolean

                • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                  MDN Reference

                  Parameters

                  Returns boolean

                • dispatchEvent(event): boolean

                • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                  MDN Reference

                  -

                  Parameters

                  Returns boolean

                listenerCount

                removeEventListener

                safeDispatchEvent

                Settings

                Member Visibility

                Theme

                On This Page

                addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                \ No newline at end of file +

                Parameters

                Returns boolean

                listenerCount

                removeEventListener

                safeDispatchEvent

                Settings

                Member Visibility

                Theme

                On This Page

                addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscoveryEvents.html b/interfaces/_libp2p_interface.PeerDiscoveryEvents.html index 60d4848589..297110d1ea 100644 --- a/interfaces/_libp2p_interface.PeerDiscoveryEvents.html +++ b/interfaces/_libp2p_interface.PeerDiscoveryEvents.html @@ -1,2 +1,2 @@ -PeerDiscoveryEvents | libp2p

                Interface PeerDiscoveryEvents

                interface PeerDiscoveryEvents {
                    peer: CustomEvent<PeerInfo>;
                }

                Properties

                peer -

                Properties

                peer

                peer: CustomEvent<PeerInfo>

                Settings

                Member Visibility

                Theme

                On This Page

                peer
                \ No newline at end of file +PeerDiscoveryEvents | libp2p

                Interface PeerDiscoveryEvents

                interface PeerDiscoveryEvents {
                    peer: CustomEvent<PeerInfo>;
                }

                Properties

                peer +

                Properties

                peer

                peer: CustomEvent<PeerInfo>

                Settings

                Member Visibility

                Theme

                On This Page

                peer
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerDiscoveryProvider.html b/interfaces/_libp2p_interface.PeerDiscoveryProvider.html index 8df2587215..4a9f3791a9 100644 --- a/interfaces/_libp2p_interface.PeerDiscoveryProvider.html +++ b/interfaces/_libp2p_interface.PeerDiscoveryProvider.html @@ -1,4 +1,4 @@ PeerDiscoveryProvider | libp2p

                Interface PeerDiscoveryProvider

                Implementers of this interface can provide a PeerDiscovery implementation to interested callers.

                -
                interface PeerDiscoveryProvider {
                    [peerDiscoverySymbol]: PeerDiscovery;
                }

                Properties

                [peerDiscoverySymbol] -

                Properties

                [peerDiscoverySymbol]

                [peerDiscoverySymbol]: PeerDiscovery

                Settings

                Member Visibility

                Theme

                On This Page

                [peerDiscoverySymbol]
                \ No newline at end of file +
                interface PeerDiscoveryProvider {
                    [peerDiscoverySymbol]: PeerDiscovery;
                }

                Properties

                [peerDiscoverySymbol] +

                Properties

                [peerDiscoverySymbol]

                [peerDiscoverySymbol]: PeerDiscovery

                Settings

                Member Visibility

                Theme

                On This Page

                [peerDiscoverySymbol]
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerId.html b/interfaces/_libp2p_interface.PeerId.html index e0e3f27392..cd6f09371b 100644 --- a/interfaces/_libp2p_interface.PeerId.html +++ b/interfaces/_libp2p_interface.PeerId.html @@ -1,4 +1,4 @@ -PeerId | libp2p

                Interface PeerId

                interface PeerId {
                    multihash: MultihashDigest<number>;
                    privateKey?: Uint8Array;
                    publicKey?: Uint8Array;
                    type: string;
                    equals(other?): boolean;
                    toBytes(): Uint8Array;
                    toCID(): CID<unknown, number, number, Version>;
                    toString(): string;
                }

                Hierarchy (view full)

                Properties

                multihash +PeerId | libp2p

                Interface PeerId

                interface PeerId {
                    multihash: MultihashDigest<number>;
                    privateKey?: Uint8Array;
                    publicKey?: Uint8Array;
                    type: string;
                    equals(other?): boolean;
                    toBytes(): Uint8Array;
                    toCID(): CID<unknown, number, number, Version>;
                    toString(): string;
                }

                Hierarchy (view full)

                Properties

                multihash privateKey? publicKey? type @@ -6,4 +6,4 @@ toBytes toCID toString -

                Properties

                multihash

                multihash: MultihashDigest<number>

                Optional privateKey

                privateKey?: Uint8Array

                Optional publicKey

                publicKey?: Uint8Array

                type

                type: string

                Methods

                equals

                toBytes

                toCID

                toString

                Settings

                Member Visibility

                Theme

                On This Page

                multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                \ No newline at end of file +

                Properties

                multihash

                multihash: MultihashDigest<number>

                Optional privateKey

                privateKey?: Uint8Array

                Optional publicKey

                publicKey?: Uint8Array

                type

                type: string

                Methods

                equals

                toBytes

                toCID

                toString

                Settings

                Member Visibility

                Theme

                On This Page

                multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerInfo.html b/interfaces/_libp2p_interface.PeerInfo.html index fd1bac3518..3824052fff 100644 --- a/interfaces/_libp2p_interface.PeerInfo.html +++ b/interfaces/_libp2p_interface.PeerInfo.html @@ -1,8 +1,8 @@ PeerInfo | libp2p

                Interface PeerInfo

                A PeerInfo is a lightweight object that represents a remote peer, it can be obtained from peer discovery mechanisms, HTTP RPC endpoints, etc.

                See

                https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info

                -
                interface PeerInfo {
                    id: PeerId;
                    multiaddrs: Multiaddr[];
                }

                Properties

                id +
                interface PeerInfo {
                    id: PeerId;
                    multiaddrs: Multiaddr[];
                }

                Properties

                id multiaddrs

                Properties

                id

                id: PeerId

                The identifier of the remote peer

                -

                multiaddrs

                multiaddrs: Multiaddr[]

                The multiaddrs a peer is listening on

                -

                Settings

                Member Visibility

                Theme

                On This Page

                idmultiaddrs
                \ No newline at end of file +

                multiaddrs

                multiaddrs: Multiaddr[]

                The multiaddrs a peer is listening on

                +

                Settings

                Member Visibility

                Theme

                On This Page

                idmultiaddrs
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQuery.html b/interfaces/_libp2p_interface.PeerQuery.html index 9cd715f15e..f6b84f3b73 100644 --- a/interfaces/_libp2p_interface.PeerQuery.html +++ b/interfaces/_libp2p_interface.PeerQuery.html @@ -1,6 +1,6 @@ PeerQuery | libp2p

                Interface PeerQuery

                A query for getting lists of peers

                -
                interface PeerQuery {
                    filters?: PeerQueryFilter[];
                    limit?: number;
                    offset?: number;
                    orders?: PeerQueryOrder[];
                }

                Properties

                filters? +
                interface PeerQuery {
                    filters?: PeerQueryFilter[];
                    limit?: number;
                    offset?: number;
                    orders?: PeerQueryOrder[];
                }

                Properties

                filters? limit? offset? orders? -

                Properties

                Optional filters

                filters?: PeerQueryFilter[]

                Optional limit

                limit?: number

                Optional offset

                offset?: number

                Optional orders

                orders?: PeerQueryOrder[]

                Settings

                Member Visibility

                Theme

                On This Page

                filterslimitoffsetorders
                \ No newline at end of file +

                Properties

                Optional filters

                filters?: PeerQueryFilter[]

                Optional limit

                limit?: number

                Optional offset

                offset?: number

                Optional orders

                orders?: PeerQueryOrder[]

                Settings

                Member Visibility

                Theme

                On This Page

                filterslimitoffsetorders
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQueryFilter.html b/interfaces/_libp2p_interface.PeerQueryFilter.html index 364057457a..c0368a2851 100644 --- a/interfaces/_libp2p_interface.PeerQueryFilter.html +++ b/interfaces/_libp2p_interface.PeerQueryFilter.html @@ -1,2 +1,2 @@ PeerQueryFilter | libp2p

                Interface PeerQueryFilter

                A predicate by which to filter lists of peers

                -
                interface PeerQueryFilter ((peer) => boolean)

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +
                interface PeerQueryFilter ((peer) => boolean)

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerQueryOrder.html b/interfaces/_libp2p_interface.PeerQueryOrder.html index 384c75626d..f6dc05ced1 100644 --- a/interfaces/_libp2p_interface.PeerQueryOrder.html +++ b/interfaces/_libp2p_interface.PeerQueryOrder.html @@ -1,2 +1,2 @@ PeerQueryOrder | libp2p

                Interface PeerQueryOrder

                A predicate by which to sort lists of peers

                -
                interface PeerQueryOrder ((a, b) => -1 | 0 | 1)

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +
                interface PeerQueryOrder ((a, b) => -1 | 0 | 1)

                Settings

                Member Visibility

                Theme

                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerRouting.html b/interfaces/_libp2p_interface.PeerRouting.html index c518719f77..fc0d5a9189 100644 --- a/interfaces/_libp2p_interface.PeerRouting.html +++ b/interfaces/_libp2p_interface.PeerRouting.html @@ -1,10 +1,10 @@ -PeerRouting | libp2p

                Interface PeerRouting

                interface PeerRouting {
                    findPeer(peerId, options?): Promise<PeerInfo>;
                    getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                }

                Methods

                findPeer +PeerRouting | libp2p

                Interface PeerRouting

                interface PeerRouting {
                    findPeer(peerId, options?): Promise<PeerInfo>;
                    getClosestPeers(key, options?): AsyncIterable<PeerInfo>;
                }

                Methods

                findPeer getClosestPeers

                Methods

                findPeer

                getClosestPeers

                getClosestPeers

                • getClosestPeers(key, options?): AsyncIterable<PeerInfo>

                • Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.

                  Parameters

                  Returns AsyncIterable<PeerInfo>

                  Example

                  // Iterate over the closest peers found for the given key
                  for await (const peer of peerRouting.getClosestPeers(key)) {
                    console.log(peer.id, peer.multiaddrs)
                  }
                  -

                Settings

                Member Visibility

                Theme

                On This Page

                findPeergetClosestPeers
                \ No newline at end of file +

                Settings

                Member Visibility

                Theme

                On This Page

                findPeergetClosestPeers
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerRoutingProvider.html b/interfaces/_libp2p_interface.PeerRoutingProvider.html index 37dd614ec0..d9360b4e32 100644 --- a/interfaces/_libp2p_interface.PeerRoutingProvider.html +++ b/interfaces/_libp2p_interface.PeerRoutingProvider.html @@ -1,4 +1,4 @@ PeerRoutingProvider | libp2p

                Interface PeerRoutingProvider

                Implementers of this interface can provide a PeerRouting implementation to interested callers.

                -
                interface PeerRoutingProvider {
                    [peerRoutingSymbol]: PeerRouting;
                }

                Properties

                [peerRoutingSymbol] -

                Properties

                [peerRoutingSymbol]

                [peerRoutingSymbol]: PeerRouting

                Settings

                Member Visibility

                Theme

                On This Page

                [peerRoutingSymbol]
                \ No newline at end of file +
                interface PeerRoutingProvider {
                    [peerRoutingSymbol]: PeerRouting;
                }

                Properties

                [peerRoutingSymbol] +

                Properties

                [peerRoutingSymbol]

                [peerRoutingSymbol]: PeerRouting

                Settings

                Member Visibility

                Theme

                On This Page

                [peerRoutingSymbol]
                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStore.html b/interfaces/_libp2p_interface.PeerStore.html index 2219b9349d..3447790c08 100644 --- a/interfaces/_libp2p_interface.PeerStore.html +++ b/interfaces/_libp2p_interface.PeerStore.html @@ -1,4 +1,4 @@ -PeerStore | libp2p

                Interface PeerStore

                interface PeerStore {
                    all(query?): Promise<Peer[]>;
                    consumePeerRecord(buf, expectedPeer?): Promise<boolean>;
                    delete(peerId): Promise<void>;
                    forEach(fn, query?): Promise<void>;
                    get(peerId): Promise<Peer>;
                    has(peerId): Promise<boolean>;
                    merge(id, data): Promise<Peer>;
                    patch(id, data): Promise<Peer>;
                    save(id, data): Promise<Peer>;
                }

                Implemented by

                  Methods

                  all +PeerStore | libp2p

                  Interface PeerStore

                  interface PeerStore {
                      all(query?): Promise<Peer[]>;
                      consumePeerRecord(buf, expectedPeer?): Promise<boolean>;
                      delete(peerId): Promise<void>;
                      forEach(fn, query?): Promise<void>;
                      get(peerId): Promise<Peer>;
                      has(peerId): Promise<boolean>;
                      merge(id, data): Promise<Peer>;
                      patch(id, data): Promise<Peer>;
                      save(id, data): Promise<Peer>;
                  }

                  Implemented by

                    Methods

                    all consumePeerRecord delete forEach @@ -10,35 +10,35 @@

                    Methods

                    all

                    consumePeerRecord

                    consumePeerRecord

                    • consumePeerRecord(buf, expectedPeer?): Promise<boolean>

                    • Unmarshal and verify a signed peer record, extract the multiaddrs and overwrite the stored addresses for the peer.

                      Optionally pass an expected PeerId to verify that the peer record was signed by that peer.

                      Parameters

                      Returns Promise<boolean>

                      Example

                      await peerStore.consumePeerRecord(buf, expectedPeer)
                      -

                    delete

                    delete

                    • delete(peerId): Promise<void>

                    • Delete all data stored for the passed peer

                      Parameters

                      Returns Promise<void>

                      Example

                      await peerStore.addressBook.set(peerId, multiaddrs)
                      await peerStore.addressBook.get(peerId)
                      // multiaddrs[]

                      await peerStore.delete(peerId)

                      await peerStore.addressBook.get(peerId)
                      // []
                      -

                    forEach

                    forEach

                    • forEach(fn, query?): Promise<void>

                    • Loop over every peer - the looping is async because we read from a datastore but the peer operation is sync, this is to prevent long-lived peer operations causing deadlocks over the datastore which can happen if they try to access the peer store during the loop

                      Parameters

                      • fn: ((peer) => void)
                          • (peer): void

                          • Parameters

                            Returns void

                      • Optional query: PeerQuery

                      Returns Promise<void>

                      Example

                      await peerStore.forEach(peer => {
                        // ...
                      })
                      -

                    get

                    get

                    has

                    has

                    merge

                    merge

                    patch

                    patch

                    save

                    save

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    allconsumePeerRecorddeleteforEachgethasmergepatchsave
                    \ No newline at end of file +

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    allconsumePeerRecorddeleteforEachgethasmergepatchsave
                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStreamEvents.html b/interfaces/_libp2p_interface.PeerStreamEvents.html index a3ef308d26..52de5bcc93 100644 --- a/interfaces/_libp2p_interface.PeerStreamEvents.html +++ b/interfaces/_libp2p_interface.PeerStreamEvents.html @@ -1,4 +1,4 @@ -PeerStreamEvents | libp2p

                    Interface PeerStreamEvents

                    interface PeerStreamEvents {
                        close: CustomEvent<never>;
                        stream:inbound: CustomEvent<never>;
                        stream:outbound: CustomEvent<never>;
                    }

                    Properties

                    close +PeerStreamEvents | libp2p

                    Interface PeerStreamEvents

                    interface PeerStreamEvents {
                        close: CustomEvent<never>;
                        stream:inbound: CustomEvent<never>;
                        stream:outbound: CustomEvent<never>;
                    }

                    Properties

                    close stream:inbound stream:outbound -

                    Properties

                    close

                    close: CustomEvent<never>

                    stream:inbound

                    stream:inbound: CustomEvent<never>

                    stream:outbound

                    stream:outbound: CustomEvent<never>

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    closestream:inboundstream:outbound
                    \ No newline at end of file +

                    Properties

                    close

                    close: CustomEvent<never>

                    stream:inbound

                    stream:inbound: CustomEvent<never>

                    stream:outbound

                    stream:outbound: CustomEvent<never>

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    closestream:inboundstream:outbound
                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerStreams.html b/interfaces/_libp2p_interface.PeerStreams.html index b681b93590..b967163131 100644 --- a/interfaces/_libp2p_interface.PeerStreams.html +++ b/interfaces/_libp2p_interface.PeerStreams.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                    -
                    interface PeerStreams {
                        id: PeerId;
                        inboundStream?: AsyncIterable<Uint8ArrayList>;
                        isWritable: boolean;
                        outboundStream?: Pushable<Uint8ArrayList, void, unknown>;
                        protocol: string;
                        addEventListener<K>(type, listener, options?): void;
                        attachInboundStream(stream): AsyncIterable<Uint8ArrayList>;
                        attachOutboundStream(stream): Promise<Pushable<Uint8ArrayList, void, unknown>>;
                        close(): void;
                        dispatchEvent(event): boolean;
                        dispatchEvent(event): boolean;
                        listenerCount(type): number;
                        removeEventListener<K>(type, listener?, options?): void;
                        removeEventListener(type, listener?, options?): void;
                        safeDispatchEvent<Detail>(type, detail): boolean;
                        write(buf): void;
                    }

                    Hierarchy (view full)

                    Properties

                    id +
                    interface PeerStreams {
                        id: PeerId;
                        inboundStream?: AsyncIterable<Uint8ArrayList>;
                        isWritable: boolean;
                        outboundStream?: Pushable<Uint8ArrayList, void, unknown>;
                        protocol: string;
                        addEventListener<K>(type, listener, options?): void;
                        attachInboundStream(stream): AsyncIterable<Uint8ArrayList>;
                        attachOutboundStream(stream): Promise<Pushable<Uint8ArrayList, void, unknown>>;
                        close(): void;
                        dispatchEvent(event): boolean;
                        dispatchEvent(event): boolean;
                        listenerCount(type): number;
                        removeEventListener<K>(type, listener?, options?): void;
                        removeEventListener(type, listener?, options?): void;
                        safeDispatchEvent<Detail>(type, detail): boolean;
                        write(buf): void;
                    }

                    Hierarchy (view full)

                    Properties

                    id inboundStream? isWritable outboundStream? @@ -17,8 +17,8 @@ removeEventListener safeDispatchEvent write -

                    Properties

                    id

                    id: PeerId

                    Optional inboundStream

                    inboundStream?: AsyncIterable<Uint8ArrayList>

                    isWritable

                    isWritable: boolean

                    Optional outboundStream

                    outboundStream?: Pushable<Uint8ArrayList, void, unknown>

                    protocol

                    protocol: string

                    Methods

                    addEventListener

                    attachInboundStream

                    attachOutboundStream

                    close

                    dispatchEvent

                    • dispatchEvent(event): boolean

                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                      +

                    Properties

                    id

                    id: PeerId

                    Optional inboundStream

                    inboundStream?: AsyncIterable<Uint8ArrayList>

                    isWritable

                    isWritable: boolean

                    Optional outboundStream

                    outboundStream?: Pushable<Uint8ArrayList, void, unknown>

                    protocol

                    protocol: string

                    Methods

                    addEventListener

                    attachInboundStream

                    attachOutboundStream

                    close

                    dispatchEvent

                    • dispatchEvent(event): boolean

                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                      MDN Reference

                      Parameters

                      Returns boolean

                    • dispatchEvent(event): boolean

                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                      MDN Reference

                      -

                      Parameters

                      Returns boolean

                    listenerCount

                    removeEventListener

                    safeDispatchEvent

                    write

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    idinboundStreamisWritableoutboundStreamprotocoladdEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
                    \ No newline at end of file +

                    Parameters

                    Returns boolean

                    listenerCount

                    removeEventListener

                    safeDispatchEvent

                    write

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    idinboundStreamisWritableoutboundStreamprotocoladdEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite
                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PeerUpdate.html b/interfaces/_libp2p_interface.PeerUpdate.html index 704a49b7a4..a24e5e2da9 100644 --- a/interfaces/_libp2p_interface.PeerUpdate.html +++ b/interfaces/_libp2p_interface.PeerUpdate.html @@ -1,4 +1,4 @@ PeerUpdate | libp2p

                    Interface PeerUpdate

                    Event detail emitted when peer data changes

                    -
                    interface PeerUpdate {
                        peer: Peer;
                        previous?: Peer;
                    }

                    Properties

                    peer +
                    interface PeerUpdate {
                        peer: Peer;
                        previous?: Peer;
                    }

                    Properties

                    peer previous? -

                    Properties

                    peer

                    peer: Peer

                    Optional previous

                    previous?: Peer

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    peerprevious
                    \ No newline at end of file +

                    Properties

                    peer

                    peer: Peer

                    Optional previous

                    previous?: Peer

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    peerprevious
                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PendingDial.html b/interfaces/_libp2p_interface.PendingDial.html index 576bf36449..cd6be64a14 100644 --- a/interfaces/_libp2p_interface.PendingDial.html +++ b/interfaces/_libp2p_interface.PendingDial.html @@ -1,12 +1,12 @@ PendingDial | libp2p

                    Interface PendingDial

                    An item in the dial queue

                    -
                    interface PendingDial {
                        id: string;
                        multiaddrs: Multiaddr[];
                        peerId?: PeerId;
                        status: PendingDialStatus;
                    }

                    Properties

                    id +
                    interface PendingDial {
                        id: string;
                        multiaddrs: Multiaddr[];
                        peerId?: PeerId;
                        status: PendingDialStatus;
                    }

                    Properties

                    id multiaddrs peerId? status

                    Properties

                    id

                    id: string

                    A unique identifier for this dial

                    -

                    multiaddrs

                    multiaddrs: Multiaddr[]

                    The list of multiaddrs that will be dialled. The returned connection will +

                    multiaddrs

                    multiaddrs: Multiaddr[]

                    The list of multiaddrs that will be dialled. The returned connection will use the first address that succeeds, all other dials part of this pending dial will be cancelled.

                    -

                    Optional peerId

                    peerId?: PeerId

                    If known, this is the peer id that libp2p expects to be dialling

                    -

                    status

                    status: PendingDialStatus

                    The current status of the dial

                    -

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    idmultiaddrspeerIdstatus
                    \ No newline at end of file +

                    Optional peerId

                    peerId?: PeerId

                    If known, this is the peer id that libp2p expects to be dialling

                    +

                    status

                    status: PendingDialStatus

                    The current status of the dial

                    +

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    idmultiaddrspeerIdstatus
                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PrivateKey.html b/interfaces/_libp2p_interface.PrivateKey.html index 8b95899307..a7bf5ac499 100644 --- a/interfaces/_libp2p_interface.PrivateKey.html +++ b/interfaces/_libp2p_interface.PrivateKey.html @@ -1,5 +1,5 @@ PrivateKey | libp2p

                    Interface PrivateKey<Type>

                    Generic private key interface

                    -
                    interface PrivateKey<Type> {
                        bytes: Uint8Array;
                        public: PublicKey<Type>;
                        equals(key): boolean;
                        export(password, format?): Promise<string>;
                        hash(): Uint8Array | Promise<Uint8Array>;
                        id(): Promise<string>;
                        marshal(): Uint8Array;
                        sign(data): Uint8Array | Promise<Uint8Array>;
                    }

                    Type Parameters

                    Implemented by

                      Properties

                      bytes +
                      interface PrivateKey<Type> {
                          bytes: Uint8Array;
                          public: PublicKey<Type>;
                          equals(key): boolean;
                          export(password, format?): Promise<string>;
                          hash(): Uint8Array | Promise<Uint8Array>;
                          id(): Promise<string>;
                          marshal(): Uint8Array;
                          sign(data): Uint8Array | Promise<Uint8Array>;
                      }

                      Type Parameters

                      Implemented by

                        Properties

                        bytes public

                        Methods

                        equals export @@ -7,9 +7,9 @@ id marshal sign -

                        Properties

                        Readonly bytes

                        bytes: Uint8Array

                        Readonly public

                        public: PublicKey<Type>

                        Methods

                        equals

                        export

                        hash

                        id

                        • id(): Promise<string>

                        • Gets the ID of the key.

                          +

                        Properties

                        Readonly bytes

                        bytes: Uint8Array

                        Readonly public

                        public: PublicKey<Type>

                        Methods

                        equals

                        export

                        hash

                        id

                        • id(): Promise<string>

                        • Gets the ID of the key.

                          The key id is the base58 encoding of the SHA-256 multihash of its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

                          -

                          Returns Promise<string>

                        marshal

                        sign

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        bytespublicequalsexporthashidmarshalsign
                        \ No newline at end of file +

                        Returns Promise<string>

                        marshal

                        sign

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        bytespublicequalsexporthashidmarshalsign
                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSub.html b/interfaces/_libp2p_interface.PubSub.html index ebfa183082..a73b2c1bce 100644 --- a/interfaces/_libp2p_interface.PubSub.html +++ b/interfaces/_libp2p_interface.PubSub.html @@ -3,7 +3,7 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                        -
                        interface PubSub<Events> {
                            globalSignaturePolicy: "StrictSign" | "StrictNoSign";
                            multicodecs: string[];
                            topicValidators: Map<string, TopicValidatorFn>;
                            addEventListener<K>(type, listener, options?): void;
                            dispatchEvent(event): boolean;
                            dispatchEvent(event): boolean;
                            getPeers(): PeerId[];
                            getSubscribers(topic): PeerId[];
                            getTopics(): string[];
                            listenerCount(type): number;
                            publish(topic, data): Promise<PublishResult>;
                            removeEventListener<K>(type, listener?, options?): void;
                            removeEventListener(type, listener?, options?): void;
                            safeDispatchEvent<Detail>(type, detail): boolean;
                            subscribe(topic): void;
                            unsubscribe(topic): void;
                        }

                        Type Parameters

                        Hierarchy (view full)

                        Implemented by

                          Properties

                          globalSignaturePolicy +
                          interface PubSub<Events> {
                              globalSignaturePolicy: "StrictSign" | "StrictNoSign";
                              multicodecs: string[];
                              topicValidators: Map<string, TopicValidatorFn>;
                              addEventListener<K>(type, listener, options?): void;
                              dispatchEvent(event): boolean;
                              dispatchEvent(event): boolean;
                              getPeers(): PeerId[];
                              getSubscribers(topic): PeerId[];
                              getTopics(): string[];
                              listenerCount(type): number;
                              publish(topic, data): Promise<PublishResult>;
                              removeEventListener<K>(type, listener?, options?): void;
                              removeEventListener(type, listener?, options?): void;
                              safeDispatchEvent<Detail>(type, detail): boolean;
                              subscribe(topic): void;
                              unsubscribe(topic): void;
                          }

                          Type Parameters

                          Hierarchy (view full)

                          Implemented by

                            Properties

                            globalSignaturePolicy multicodecs topicValidators

                            Methods

                            addEventListener @@ -21,29 +21,29 @@ signed or unsigned messages.

                            Signed messages prevent spoofing message senders and should be preferred to using unsigned messages.

                            -

                            multicodecs

                            multicodecs: string[]

                            A list of multicodecs that contain the pubsub protocol name.

                            -

                            topicValidators

                            topicValidators: Map<string, TopicValidatorFn>

                            Pubsub routers support message validators per topic, which will validate the message +

                            multicodecs

                            multicodecs: string[]

                            A list of multicodecs that contain the pubsub protocol name.

                            +

                            topicValidators

                            topicValidators: Map<string, TopicValidatorFn>

                            Pubsub routers support message validators per topic, which will validate the message before its propagations. They are stored in a map where keys are the topic name and values are the validators.

                            Example

                            const topic = 'topic'
                            const validateMessage = (msgTopic, msg) => {
                              const input = uint8ArrayToString(msg.data)
                              const validInputs = ['a', 'b', 'c']

                              if (!validInputs.includes(input)) {
                                throw new Error('no valid input received')
                              }
                            }
                            libp2p.pubsub.topicValidators.set(topic, validateMessage)
                            -

                            Methods

                            addEventListener

                            dispatchEvent

                            • dispatchEvent(event): boolean

                            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                              +

                            Methods

                            addEventListener

                            dispatchEvent

                            • dispatchEvent(event): boolean

                            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                              MDN Reference

                              Parameters

                              Returns boolean

                            • dispatchEvent(event): boolean

                            • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                              MDN Reference

                              -

                              Parameters

                              Returns boolean

                            getPeers

                            getSubscribers

                            • getSubscribers(topic): PeerId[]

                            • Gets a list of the PeerIds that are subscribed to one topic.

                              +

                              Parameters

                              Returns boolean

                            getPeers

                            getSubscribers

                            getTopics

                            getTopics

                            listenerCount

                            publish

                            listenerCount

                            publish

                            removeEventListener

                            safeDispatchEvent

                            subscribe

                            removeEventListener

                            safeDispatchEvent

                            subscribe

                            • subscribe(topic): void

                            • Subscribes to a pubsub topic.

                              Parameters

                              • topic: string

                              Returns void

                              Example

                              const topic = 'topic'
                              const handler = (msg) => {
                                if (msg.topic === topic) {
                                  // msg.data - pubsub data received
                                }
                              }

                              libp2p.pubsub.addEventListener('message', handler)
                              libp2p.pubsub.subscribe(topic)
                              -

                            unsubscribe

                            unsubscribe

                            • unsubscribe(topic): void

                            • Unsubscribes from a pubsub topic.

                              Parameters

                              • topic: string

                              Returns void

                              Example

                              const topic = 'topic'
                              const handler = (msg) => {
                                // msg.data - pubsub data received
                              }

                              libp2p.pubsub.removeEventListener(topic handler)
                              libp2p.pubsub.unsubscribe(topic)
                              -

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            globalSignaturePolicymulticodecstopicValidatorsaddEventListenerdispatchEventgetPeersgetSubscribersgetTopicslistenerCountpublishremoveEventListenersafeDispatchEventsubscribeunsubscribe
                            \ No newline at end of file +

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            globalSignaturePolicymulticodecstopicValidatorsaddEventListenerdispatchEventgetPeersgetSubscribersgetTopicslistenerCountpublishremoveEventListenersafeDispatchEventsubscribeunsubscribe
                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubEvents.html b/interfaces/_libp2p_interface.PubSubEvents.html index 91fd7afd60..26a2b841ea 100644 --- a/interfaces/_libp2p_interface.PubSubEvents.html +++ b/interfaces/_libp2p_interface.PubSubEvents.html @@ -1,3 +1,3 @@ -PubSubEvents | libp2p

                            Interface PubSubEvents

                            interface PubSubEvents {
                                message: CustomEvent<Message>;
                                subscription-change: CustomEvent<SubscriptionChangeData>;
                            }

                            Properties

                            message +PubSubEvents | libp2p

                            Interface PubSubEvents

                            interface PubSubEvents {
                                message: CustomEvent<Message>;
                                subscription-change: CustomEvent<SubscriptionChangeData>;
                            }

                            Properties

                            message subscription-change -

                            Properties

                            message

                            message: CustomEvent<Message>

                            subscription-change

                            subscription-change: CustomEvent<SubscriptionChangeData>

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            messagesubscription-change
                            \ No newline at end of file +

                            Properties

                            message

                            message: CustomEvent<Message>

                            subscription-change

                            subscription-change: CustomEvent<SubscriptionChangeData>

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            messagesubscription-change
                            \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubInit.html b/interfaces/_libp2p_interface.PubSubInit.html index 576a428a27..2530204e92 100644 --- a/interfaces/_libp2p_interface.PubSubInit.html +++ b/interfaces/_libp2p_interface.PubSubInit.html @@ -1,4 +1,4 @@ -PubSubInit | libp2p

                            Interface PubSubInit

                            interface PubSubInit {
                                canRelayMessage?: boolean;
                                emitSelf?: boolean;
                                enabled?: boolean;
                                globalSignaturePolicy?: SignaturePolicy;
                                maxInboundStreams?: number;
                                maxOutboundStreams?: number;
                                messageProcessingConcurrency?: number;
                                multicodecs?: string[];
                            }

                            Hierarchy

                            • PubSubInit

                              Properties

                              canRelayMessage? +PubSubInit | libp2p

                              Interface PubSubInit

                              interface PubSubInit {
                                  canRelayMessage?: boolean;
                                  emitSelf?: boolean;
                                  enabled?: boolean;
                                  globalSignaturePolicy?: SignaturePolicy;
                                  maxInboundStreams?: number;
                                  maxOutboundStreams?: number;
                                  messageProcessingConcurrency?: number;
                                  multicodecs?: string[];
                              }

                              Hierarchy

                              • PubSubInit

                                Properties

                                canRelayMessage? emitSelf? enabled? globalSignaturePolicy? @@ -7,9 +7,9 @@ messageProcessingConcurrency? multicodecs?

                                Properties

                                Optional canRelayMessage

                                canRelayMessage?: boolean

                                if can relay messages not subscribed

                                -

                                Optional emitSelf

                                emitSelf?: boolean

                                if publish should emit to self, if subscribed

                                -

                                Optional enabled

                                enabled?: boolean

                                Optional globalSignaturePolicy

                                globalSignaturePolicy?: SignaturePolicy

                                defines how signatures should be handled

                                -

                                Optional maxInboundStreams

                                maxInboundStreams?: number

                                How many parallel incoming streams to allow on the pubsub protocol per-connection

                                -

                                Optional maxOutboundStreams

                                maxOutboundStreams?: number

                                How many parallel outgoing streams to allow on the pubsub protocol per-connection

                                -

                                Optional messageProcessingConcurrency

                                messageProcessingConcurrency?: number

                                handle this many incoming pubsub messages concurrently

                                -

                                Optional multicodecs

                                multicodecs?: string[]

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecs
                                \ No newline at end of file +

                                Optional emitSelf

                                emitSelf?: boolean

                                if publish should emit to self, if subscribed

                                +

                                Optional enabled

                                enabled?: boolean

                                Optional globalSignaturePolicy

                                globalSignaturePolicy?: SignaturePolicy

                                defines how signatures should be handled

                                +

                                Optional maxInboundStreams

                                maxInboundStreams?: number

                                How many parallel incoming streams to allow on the pubsub protocol per-connection

                                +

                                Optional maxOutboundStreams

                                maxOutboundStreams?: number

                                How many parallel outgoing streams to allow on the pubsub protocol per-connection

                                +

                                Optional messageProcessingConcurrency

                                messageProcessingConcurrency?: number

                                handle this many incoming pubsub messages concurrently

                                +

                                Optional multicodecs

                                multicodecs?: string[]

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                canRelayMessageemitSelfenabledglobalSignaturePolicymaxInboundStreamsmaxOutboundStreamsmessageProcessingConcurrencymulticodecs
                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPC.html b/interfaces/_libp2p_interface.PubSubRPC.html index 3c9ba945c2..754810e893 100644 --- a/interfaces/_libp2p_interface.PubSubRPC.html +++ b/interfaces/_libp2p_interface.PubSubRPC.html @@ -1,3 +1,3 @@ -PubSubRPC | libp2p

                                Interface PubSubRPC

                                interface PubSubRPC {
                                    messages: PubSubRPCMessage[];
                                    subscriptions: PubSubRPCSubscription[];
                                }

                                Properties

                                messages +PubSubRPC | libp2p

                                Interface PubSubRPC

                                interface PubSubRPC {
                                    messages: PubSubRPCMessage[];
                                    subscriptions: PubSubRPCSubscription[];
                                }

                                Properties

                                messages subscriptions -

                                Properties

                                messages

                                messages: PubSubRPCMessage[]

                                subscriptions

                                subscriptions: PubSubRPCSubscription[]

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                messagessubscriptions
                                \ No newline at end of file +

                                Properties

                                messages

                                messages: PubSubRPCMessage[]

                                subscriptions

                                subscriptions: PubSubRPCSubscription[]

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                messagessubscriptions
                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPCMessage.html b/interfaces/_libp2p_interface.PubSubRPCMessage.html index 4b19ee4a6a..8e212333c7 100644 --- a/interfaces/_libp2p_interface.PubSubRPCMessage.html +++ b/interfaces/_libp2p_interface.PubSubRPCMessage.html @@ -1,7 +1,7 @@ -PubSubRPCMessage | libp2p

                                Interface PubSubRPCMessage

                                interface PubSubRPCMessage {
                                    data?: Uint8Array;
                                    from?: Uint8Array;
                                    key?: Uint8Array;
                                    sequenceNumber?: Uint8Array;
                                    signature?: Uint8Array;
                                    topic?: string;
                                }

                                Properties

                                data? +PubSubRPCMessage | libp2p

                                Interface PubSubRPCMessage

                                interface PubSubRPCMessage {
                                    data?: Uint8Array;
                                    from?: Uint8Array;
                                    key?: Uint8Array;
                                    sequenceNumber?: Uint8Array;
                                    signature?: Uint8Array;
                                    topic?: string;
                                }

                                Properties

                                data? from? key? sequenceNumber? signature? topic? -

                                Properties

                                Optional data

                                data?: Uint8Array

                                Optional from

                                from?: Uint8Array

                                Optional key

                                key?: Uint8Array

                                Optional sequenceNumber

                                sequenceNumber?: Uint8Array

                                Optional signature

                                signature?: Uint8Array

                                Optional topic

                                topic?: string

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                datafromkeysequenceNumbersignaturetopic
                                \ No newline at end of file +

                                Properties

                                Optional data

                                data?: Uint8Array

                                Optional from

                                from?: Uint8Array

                                Optional key

                                key?: Uint8Array

                                Optional sequenceNumber

                                sequenceNumber?: Uint8Array

                                Optional signature

                                signature?: Uint8Array

                                Optional topic

                                topic?: string

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                datafromkeysequenceNumbersignaturetopic
                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PubSubRPCSubscription.html b/interfaces/_libp2p_interface.PubSubRPCSubscription.html index 4577416e06..ec187eda03 100644 --- a/interfaces/_libp2p_interface.PubSubRPCSubscription.html +++ b/interfaces/_libp2p_interface.PubSubRPCSubscription.html @@ -1,3 +1,3 @@ -PubSubRPCSubscription | libp2p

                                Interface PubSubRPCSubscription

                                interface PubSubRPCSubscription {
                                    subscribe?: boolean;
                                    topic?: string;
                                }

                                Properties

                                subscribe? +PubSubRPCSubscription | libp2p

                                Interface PubSubRPCSubscription

                                interface PubSubRPCSubscription {
                                    subscribe?: boolean;
                                    topic?: string;
                                }

                                Properties

                                subscribe? topic? -

                                Properties

                                Optional subscribe

                                subscribe?: boolean

                                Optional topic

                                topic?: string

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                subscribetopic
                                \ No newline at end of file +

                                Properties

                                Optional subscribe

                                subscribe?: boolean

                                Optional topic

                                topic?: string

                                Settings

                                Member Visibility

                                Theme

                                On This Page

                                subscribetopic
                                \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PublicKey.html b/interfaces/_libp2p_interface.PublicKey.html index b626ebcc93..b42eb0c9ec 100644 --- a/interfaces/_libp2p_interface.PublicKey.html +++ b/interfaces/_libp2p_interface.PublicKey.html @@ -1,6 +1,6 @@ -PublicKey | libp2p

                                Interface PublicKey<Type>

                                interface PublicKey<Type> {
                                    bytes: Uint8Array;
                                    equals(key): boolean;
                                    hash(): Uint8Array | Promise<Uint8Array>;
                                    marshal(): Uint8Array;
                                    verify(data, sig): boolean | Promise<boolean>;
                                }

                                Type Parameters

                                Implemented by

                                  Properties

                                  bytes +PublicKey | libp2p

                                  Interface PublicKey<Type>

                                  interface PublicKey<Type> {
                                      bytes: Uint8Array;
                                      equals(key): boolean;
                                      hash(): Uint8Array | Promise<Uint8Array>;
                                      marshal(): Uint8Array;
                                      verify(data, sig): boolean | Promise<boolean>;
                                  }

                                  Type Parameters

                                  Implemented by

                                    Properties

                                    bytes

                                    Methods

                                    equals hash marshal verify -

                                    Properties

                                    Readonly bytes

                                    bytes: Uint8Array

                                    Methods

                                    equals

                                    hash

                                    marshal

                                    verify

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    bytesequalshashmarshalverify
                                    \ No newline at end of file +

                                    Properties

                                    Readonly bytes

                                    bytes: Uint8Array

                                    Methods

                                    equals

                                    hash

                                    marshal

                                    verify

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    bytesequalshashmarshalverify
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.PublishResult.html b/interfaces/_libp2p_interface.PublishResult.html index 1dfc6fb734..1cae1e90e0 100644 --- a/interfaces/_libp2p_interface.PublishResult.html +++ b/interfaces/_libp2p_interface.PublishResult.html @@ -1,2 +1,2 @@ -PublishResult | libp2p

                                    Interface PublishResult

                                    interface PublishResult {
                                        recipients: PeerId[];
                                    }

                                    Properties

                                    recipients -

                                    Properties

                                    recipients

                                    recipients: PeerId[]

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    recipients
                                    \ No newline at end of file +PublishResult | libp2p

                                    Interface PublishResult

                                    interface PublishResult {
                                        recipients: PeerId[];
                                    }

                                    Properties

                                    recipients +

                                    Properties

                                    recipients

                                    recipients: PeerId[]

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    recipients
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RSAPeerId.html b/interfaces/_libp2p_interface.RSAPeerId.html index 0a0f2c161e..0f2133bab5 100644 --- a/interfaces/_libp2p_interface.RSAPeerId.html +++ b/interfaces/_libp2p_interface.RSAPeerId.html @@ -1,4 +1,4 @@ -RSAPeerId | libp2p

                                    Interface RSAPeerId

                                    interface RSAPeerId {
                                        multihash: MultihashDigest<number>;
                                        privateKey?: Uint8Array;
                                        publicKey?: Uint8Array;
                                        type: "RSA";
                                        equals(other?): boolean;
                                        toBytes(): Uint8Array;
                                        toCID(): CID<unknown, number, number, Version>;
                                        toString(): string;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    multihash +RSAPeerId | libp2p

                                    Interface RSAPeerId

                                    interface RSAPeerId {
                                        multihash: MultihashDigest<number>;
                                        privateKey?: Uint8Array;
                                        publicKey?: Uint8Array;
                                        type: "RSA";
                                        equals(other?): boolean;
                                        toBytes(): Uint8Array;
                                        toCID(): CID<unknown, number, number, Version>;
                                        toString(): string;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    multihash privateKey? publicKey? type @@ -6,4 +6,4 @@ toBytes toCID toString -

                                    Properties

                                    multihash

                                    multihash: MultihashDigest<number>

                                    Optional privateKey

                                    privateKey?: Uint8Array

                                    Optional Readonly publicKey

                                    publicKey?: Uint8Array

                                    Readonly type

                                    type: "RSA"

                                    Methods

                                    equals

                                    toBytes

                                    toCID

                                    toString

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                    \ No newline at end of file +

                                    Properties

                                    multihash

                                    multihash: MultihashDigest<number>

                                    Optional privateKey

                                    privateKey?: Uint8Array

                                    Optional Readonly publicKey

                                    publicKey?: Uint8Array

                                    Readonly type

                                    type: "RSA"

                                    Methods

                                    equals

                                    toBytes

                                    toCID

                                    toString

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Record.html b/interfaces/_libp2p_interface.Record.html index 84ee84e5a2..6947296de3 100644 --- a/interfaces/_libp2p_interface.Record.html +++ b/interfaces/_libp2p_interface.Record.html @@ -1,10 +1,10 @@ Record | libp2p

                                    Interface Record

                                    Record is the base implementation of a record that can be used as the payload of a libp2p envelope.

                                    -
                                    interface Record {
                                        codec: Uint8Array;
                                        domain: string;
                                        equals(other): boolean;
                                        marshal(): Uint8Array;
                                    }

                                    Properties

                                    codec +
                                    interface Record {
                                        codec: Uint8Array;
                                        domain: string;
                                        equals(other): boolean;
                                        marshal(): Uint8Array;
                                    }

                                    Properties

                                    codec domain

                                    Methods

                                    equals marshal

                                    Properties

                                    codec

                                    codec: Uint8Array

                                    identifier of the type of record

                                    -

                                    domain

                                    domain: string

                                    signature domain.

                                    -

                                    Methods

                                    equals

                                    marshal

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    codecdomainequalsmarshal
                                    \ No newline at end of file +

                                    domain

                                    domain: string

                                    signature domain.

                                    +

                                    Methods

                                    equals

                                    marshal

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    codecdomainequalsmarshal
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.RoutingOptions.html b/interfaces/_libp2p_interface.RoutingOptions.html index af7c7974a6..78a09ac71e 100644 --- a/interfaces/_libp2p_interface.RoutingOptions.html +++ b/interfaces/_libp2p_interface.RoutingOptions.html @@ -2,14 +2,14 @@ controlling where the values are read from. By default libp2p will check local caches but may not use the network if a valid local value is found, these options allow tuning that behaviour.

                                    -
                                    interface RoutingOptions {
                                        onProgress?: ((evt) => void);
                                        signal?: AbortSignal;
                                        useCache?: boolean;
                                        useNetwork?: boolean;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    onProgress? +
                                    interface RoutingOptions {
                                        onProgress?: ((evt) => void);
                                        signal?: AbortSignal;
                                        useCache?: boolean;
                                        useNetwork?: boolean;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    onProgress? signal? useCache? useNetwork? -

                                    Properties

                                    Optional onProgress

                                    onProgress?: ((evt) => void)

                                    Type declaration

                                      • (evt): void

                                      • Parameters

                                        • evt: any

                                        Returns void

                                    Optional signal

                                    signal?: AbortSignal

                                    Optional useCache

                                    useCache?: boolean

                                    Pass false to not use cached values

                                    +

                                    Properties

                                    Optional onProgress

                                    onProgress?: ((evt) => void)

                                    Type declaration

                                      • (evt): void

                                      • Parameters

                                        • evt: any

                                        Returns void

                                    Optional signal

                                    signal?: AbortSignal

                                    Optional useCache

                                    useCache?: boolean

                                    Pass false to not use cached values

                                    Default

                                    true
                                    -

                                    Optional useNetwork

                                    useNetwork?: boolean

                                    Pass false to not use the network

                                    +

                                    Optional useNetwork

                                    useNetwork?: boolean

                                    Pass false to not use the network

                                    Default

                                    true
                                    -

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    onProgresssignaluseCacheuseNetwork
                                    \ No newline at end of file +

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    onProgresssignaluseCacheuseNetwork
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Secp256k1PeerId.html b/interfaces/_libp2p_interface.Secp256k1PeerId.html index d81e0f260e..5447f97cfb 100644 --- a/interfaces/_libp2p_interface.Secp256k1PeerId.html +++ b/interfaces/_libp2p_interface.Secp256k1PeerId.html @@ -1,4 +1,4 @@ -Secp256k1PeerId | libp2p

                                    Interface Secp256k1PeerId

                                    interface Secp256k1PeerId {
                                        multihash: MultihashDigest<number>;
                                        privateKey?: Uint8Array;
                                        publicKey: Uint8Array;
                                        type: "secp256k1";
                                        equals(other?): boolean;
                                        toBytes(): Uint8Array;
                                        toCID(): CID<unknown, number, number, Version>;
                                        toString(): string;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    multihash +Secp256k1PeerId | libp2p

                                    Interface Secp256k1PeerId

                                    interface Secp256k1PeerId {
                                        multihash: MultihashDigest<number>;
                                        privateKey?: Uint8Array;
                                        publicKey: Uint8Array;
                                        type: "secp256k1";
                                        equals(other?): boolean;
                                        toBytes(): Uint8Array;
                                        toCID(): CID<unknown, number, number, Version>;
                                        toString(): string;
                                    }

                                    Hierarchy (view full)

                                    Properties

                                    multihash privateKey? publicKey type @@ -6,4 +6,4 @@ toBytes toCID toString -

                                    Properties

                                    multihash

                                    multihash: MultihashDigest<number>

                                    Optional privateKey

                                    privateKey?: Uint8Array

                                    Readonly publicKey

                                    publicKey: Uint8Array

                                    Readonly type

                                    type: "secp256k1"

                                    Methods

                                    equals

                                    toBytes

                                    toCID

                                    toString

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                    \ No newline at end of file +

                                    Properties

                                    multihash

                                    multihash: MultihashDigest<number>

                                    Optional privateKey

                                    privateKey?: Uint8Array

                                    Readonly publicKey

                                    publicKey: Uint8Array

                                    Readonly type

                                    type: "secp256k1"

                                    Methods

                                    equals

                                    toBytes

                                    toCID

                                    toString

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SecuredConnection.html b/interfaces/_libp2p_interface.SecuredConnection.html index da80c15d44..4d9a853ce4 100644 --- a/interfaces/_libp2p_interface.SecuredConnection.html +++ b/interfaces/_libp2p_interface.SecuredConnection.html @@ -1,4 +1,4 @@ -SecuredConnection | libp2p

                                    Interface SecuredConnection<Stream, Extension>

                                    interface SecuredConnection<Stream, Extension> {
                                        conn: Stream;
                                        remoteExtensions?: Extension;
                                        remotePeer: PeerId;
                                    }

                                    Type Parameters

                                    • Stream = any
                                    • Extension = unknown

                                    Properties

                                    conn +SecuredConnection | libp2p

                                    Interface SecuredConnection<Stream, Extension>

                                    interface SecuredConnection<Stream, Extension> {
                                        conn: Stream;
                                        remoteExtensions?: Extension;
                                        remotePeer: PeerId;
                                    }

                                    Type Parameters

                                    • Stream = any
                                    • Extension = unknown

                                    Properties

                                    conn remoteExtensions? remotePeer -

                                    Properties

                                    conn

                                    conn: Stream

                                    Optional remoteExtensions

                                    remoteExtensions?: Extension

                                    remotePeer

                                    remotePeer: PeerId

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    connremoteExtensionsremotePeer
                                    \ No newline at end of file +

                                    Properties

                                    conn

                                    conn: Stream

                                    Optional remoteExtensions

                                    remoteExtensions?: Extension

                                    remotePeer

                                    remotePeer: PeerId

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    connremoteExtensionsremotePeer
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SignedMessage.html b/interfaces/_libp2p_interface.SignedMessage.html index b176029708..70b33a5b9a 100644 --- a/interfaces/_libp2p_interface.SignedMessage.html +++ b/interfaces/_libp2p_interface.SignedMessage.html @@ -1,8 +1,8 @@ -SignedMessage | libp2p

                                    Interface SignedMessage

                                    interface SignedMessage {
                                        data: Uint8Array;
                                        from: PeerId;
                                        key: Uint8Array;
                                        sequenceNumber: bigint;
                                        signature: Uint8Array;
                                        topic: string;
                                        type: "signed";
                                    }

                                    Properties

                                    data +SignedMessage | libp2p

                                    Interface SignedMessage

                                    interface SignedMessage {
                                        data: Uint8Array;
                                        from: PeerId;
                                        key: Uint8Array;
                                        sequenceNumber: bigint;
                                        signature: Uint8Array;
                                        topic: string;
                                        type: "signed";
                                    }

                                    Properties

                                    data from key sequenceNumber signature topic type -

                                    Properties

                                    data

                                    data: Uint8Array

                                    from

                                    from: PeerId

                                    key

                                    key: Uint8Array

                                    sequenceNumber

                                    sequenceNumber: bigint

                                    signature

                                    signature: Uint8Array

                                    topic

                                    topic: string

                                    type

                                    type: "signed"

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    datafromkeysequenceNumbersignaturetopictype
                                    \ No newline at end of file +

                                    Properties

                                    data

                                    data: Uint8Array

                                    from

                                    from: PeerId

                                    key

                                    key: Uint8Array

                                    sequenceNumber

                                    sequenceNumber: bigint

                                    signature

                                    signature: Uint8Array

                                    topic

                                    topic: string

                                    type

                                    type: "signed"

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    datafromkeysequenceNumbersignaturetopictype
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SignedPeerRecord.html b/interfaces/_libp2p_interface.SignedPeerRecord.html index 8c26eb4ad2..d19dd4dc4a 100644 --- a/interfaces/_libp2p_interface.SignedPeerRecord.html +++ b/interfaces/_libp2p_interface.SignedPeerRecord.html @@ -1,4 +1,4 @@ SignedPeerRecord | libp2p

                                    Interface SignedPeerRecord

                                    Peer data signed by the remote Peer's public key

                                    -
                                    interface SignedPeerRecord {
                                        addresses: Multiaddr[];
                                        seq: bigint;
                                    }

                                    Properties

                                    addresses +
                                    interface SignedPeerRecord {
                                        addresses: Multiaddr[];
                                        seq: bigint;
                                    }

                                    Properties

                                    addresses seq -

                                    Properties

                                    addresses

                                    addresses: Multiaddr[]

                                    seq

                                    seq: bigint

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    addressesseq
                                    \ No newline at end of file +

                                    Properties

                                    addresses

                                    addresses: Multiaddr[]

                                    seq

                                    seq: bigint

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    addressesseq
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Startable.html b/interfaces/_libp2p_interface.Startable.html index ca8d62395b..aa8730986a 100644 --- a/interfaces/_libp2p_interface.Startable.html +++ b/interfaces/_libp2p_interface.Startable.html @@ -1,5 +1,5 @@ Startable | libp2p

                                    Interface Startable

                                    Implemented by components that have a lifecycle

                                    -
                                    interface Startable {
                                        afterStart?(): void | Promise<void>;
                                        afterStop?(): void | Promise<void>;
                                        beforeStart?(): void | Promise<void>;
                                        beforeStop?(): void | Promise<void>;
                                        start(): void | Promise<void>;
                                        stop(): void | Promise<void>;
                                    }

                                    Hierarchy (view full)

                                    Methods

                                    afterStart? +
                                    interface Startable {
                                        afterStart?(): void | Promise<void>;
                                        afterStop?(): void | Promise<void>;
                                        beforeStart?(): void | Promise<void>;
                                        beforeStop?(): void | Promise<void>;
                                        start(): void | Promise<void>;
                                        stop(): void | Promise<void>;
                                    }

                                    Hierarchy (view full)

                                    Methods

                                    afterStart? afterStop? beforeStart? beforeStop? @@ -7,14 +7,14 @@ stop

                                    Methods

                                    Optional afterStart

                                    • afterStart(): void | Promise<void>

                                    • If implemented, this method will be invoked after the start method.

                                      All other components will have had their start method invoked before this method is called.

                                      -

                                      Returns void | Promise<void>

                                    Optional afterStop

                                    Optional afterStop

                                    • afterStop(): void | Promise<void>

                                    • If implemented, this method will be invoked after the stop method.

                                      All other components will have had their stop method invoked before this method is called.

                                      -

                                      Returns void | Promise<void>

                                    Optional beforeStart

                                    Optional beforeStart

                                    Optional beforeStop

                                    Optional beforeStop

                                    start

                                    start

                                    stop

                                    stop

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    afterStartafterStopbeforeStartbeforeStopstartstop
                                    \ No newline at end of file +

                                    Returns void | Promise<void>

                                    Settings

                                    Member Visibility

                                    Theme

                                    On This Page

                                    afterStartafterStopbeforeStartbeforeStopstartstop
                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StopTimer.html b/interfaces/_libp2p_interface.StopTimer.html index e84f51c2c7..5af75135f6 100644 --- a/interfaces/_libp2p_interface.StopTimer.html +++ b/interfaces/_libp2p_interface.StopTimer.html @@ -1,3 +1,3 @@ StopTimer | libp2p

                                    Interface StopTimer

                                    Call this function to stop the timer returned from the .timer method on the metric

                                    -
                                    interface StopTimer (() => void)

                                    Settings

                                    Member Visibility

                                    Theme

                                    \ No newline at end of file +
                                    interface StopTimer (() => void)

                                    Settings

                                    Member Visibility

                                    Theme

                                    \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Stream.html b/interfaces/_libp2p_interface.Stream.html index 0dd60c404f..7e154211ad 100644 --- a/interfaces/_libp2p_interface.Stream.html +++ b/interfaces/_libp2p_interface.Stream.html @@ -2,7 +2,7 @@ can be written to and read from at both ends.

                                    It may be encrypted and multiplexed depending on the configuration of the nodes.

                                    -
                                    interface Stream {
                                        direction: Direction;
                                        id: string;
                                        log: Logger;
                                        metadata: Record<string, any>;
                                        protocol?: string;
                                        readStatus: ReadStatus;
                                        sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                        source: AsyncGenerator<Uint8ArrayList, any, unknown>;
                                        status: StreamStatus;
                                        timeline: StreamTimeline;
                                        writeStatus: WriteStatus;
                                        abort(err): void;
                                        close(options?): Promise<void>;
                                        closeRead(options?): Promise<void>;
                                        closeWrite(options?): Promise<void>;
                                    }

                                    Hierarchy

                                    Implemented by

                                      Properties

                                      direction +
                                      interface Stream {
                                          direction: Direction;
                                          id: string;
                                          log: Logger;
                                          metadata: Record<string, any>;
                                          protocol?: string;
                                          readStatus: ReadStatus;
                                          sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>;
                                          source: AsyncGenerator<Uint8ArrayList, any, unknown>;
                                          status: StreamStatus;
                                          timeline: StreamTimeline;
                                          writeStatus: WriteStatus;
                                          abort(err): void;
                                          close(options?): Promise<void>;
                                          closeRead(options?): Promise<void>;
                                          closeWrite(options?): Promise<void>;
                                      }

                                      Hierarchy

                                      Implemented by

                                        Properties

                                        direction id log metadata @@ -18,25 +18,25 @@ closeRead closeWrite

                                        Properties

                                        direction

                                        direction: Direction

                                        Outbound streams are opened by the local node, inbound streams are opened by the remote

                                        -

                                        id

                                        id: string

                                        Unique identifier for a stream. Identifiers are not unique across muxers.

                                        -

                                        log

                                        log: Logger

                                        The stream logger

                                        -

                                        metadata

                                        metadata: Record<string, any>

                                        User defined stream metadata

                                        -

                                        Optional protocol

                                        protocol?: string

                                        The protocol negotiated for this stream

                                        -

                                        readStatus

                                        readStatus: ReadStatus

                                        The current status of the readable end of the stream

                                        -

                                        sink

                                        sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                        source

                                        source: AsyncGenerator<Uint8ArrayList, any, unknown>

                                        status

                                        status: StreamStatus

                                        The current status of the stream

                                        -

                                        timeline

                                        timeline: StreamTimeline

                                        Lifecycle times for the stream

                                        -

                                        writeStatus

                                        writeStatus: WriteStatus

                                        The current status of the writable end of the stream

                                        -

                                        Methods

                                        abort

                                        id

                                        id: string

                                        Unique identifier for a stream. Identifiers are not unique across muxers.

                                        +

                                        log

                                        log: Logger

                                        The stream logger

                                        +

                                        metadata

                                        metadata: Record<string, any>

                                        User defined stream metadata

                                        +

                                        Optional protocol

                                        protocol?: string

                                        The protocol negotiated for this stream

                                        +

                                        readStatus

                                        readStatus: ReadStatus

                                        The current status of the readable end of the stream

                                        +

                                        sink

                                        sink: Sink<Source<Uint8Array | Uint8ArrayList>, Promise<void>>

                                        source

                                        source: AsyncGenerator<Uint8ArrayList, any, unknown>

                                        status

                                        status: StreamStatus

                                        The current status of the stream

                                        +

                                        timeline

                                        timeline: StreamTimeline

                                        Lifecycle times for the stream

                                        +

                                        writeStatus

                                        writeStatus: WriteStatus

                                        The current status of the writable end of the stream

                                        +

                                        Methods

                                        abort

                                        • abort(err): void

                                        • Closes the stream for reading and writing. This should be called when a local error has occurred.

                                          Note, if called without an error any buffered data in the source can still be consumed and the stream will end normally.

                                          This will cause a RESET message to be sent to the remote, unless the sink has already ended.

                                          The sink will return and the source will throw if an error is passed or return normally if not.

                                          -

                                          Parameters

                                          Returns void

                                        close

                                        close

                                        • close(options?): Promise<void>

                                        • Closes the stream for reading and writing.

                                          Any buffered data in the source can still be consumed and the stream will end normally.

                                          This will cause a CLOSE message to be sent to the remote, unless the sink has already ended.

                                          The sink and the source will return normally.

                                          -

                                          Parameters

                                          Returns Promise<void>

                                        closeRead

                                        closeRead

                                        • closeRead(options?): Promise<void>

                                        • Closes the stream for reading. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

                                          This function is called automatically by the muxer when it receives a CLOSE message from the remote.

                                          The source will return normally, the sink will continue to consume.

                                          -

                                          Parameters

                                          Returns Promise<void>

                                        closeWrite

                                        closeWrite

                                        • closeWrite(options?): Promise<void>

                                        • Closes the stream for writing. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.

                                          The source will return normally, the sink will continue to consume.

                                          -

                                          Parameters

                                          Returns Promise<void>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        directionidlogmetadataprotocolreadStatussinksourcestatustimelinewriteStatusabortclosecloseReadcloseWrite
                                        \ No newline at end of file +

                                        Parameters

                                        Returns Promise<void>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        directionidlogmetadataprotocolreadStatussinksourcestatustimelinewriteStatusabortclosecloseReadcloseWrite
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandler.html b/interfaces/_libp2p_interface.StreamHandler.html index 311d4c7ee5..42fbfc23cd 100644 --- a/interfaces/_libp2p_interface.StreamHandler.html +++ b/interfaces/_libp2p_interface.StreamHandler.html @@ -1 +1 @@ -StreamHandler | libp2p

                                        Interface StreamHandler

                                        interface StreamHandler ((data) => void)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file +StreamHandler | libp2p

                                        Interface StreamHandler

                                        interface StreamHandler ((data) => void)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandlerOptions.html b/interfaces/_libp2p_interface.StreamHandlerOptions.html index d522d1ffd2..984aa675e8 100644 --- a/interfaces/_libp2p_interface.StreamHandlerOptions.html +++ b/interfaces/_libp2p_interface.StreamHandlerOptions.html @@ -1,8 +1,8 @@ -StreamHandlerOptions | libp2p

                                        Interface StreamHandlerOptions

                                        interface StreamHandlerOptions {
                                            maxInboundStreams?: number;
                                            maxOutboundStreams?: number;
                                            runOnTransientConnection?: boolean;
                                        }

                                        Properties

                                        maxInboundStreams? +StreamHandlerOptions | libp2p

                                        Interface StreamHandlerOptions

                                        interface StreamHandlerOptions {
                                            maxInboundStreams?: number;
                                            maxOutboundStreams?: number;
                                            runOnTransientConnection?: boolean;
                                        }

                                        Properties

                                        maxInboundStreams? maxOutboundStreams? runOnTransientConnection?

                                        Properties

                                        Optional maxInboundStreams

                                        maxInboundStreams?: number

                                        How many incoming streams can be open for this protocol at the same time on each connection (default: 32)

                                        -

                                        Optional maxOutboundStreams

                                        maxOutboundStreams?: number

                                        How many outgoing streams can be open for this protocol at the same time on each connection (default: 64)

                                        -

                                        Optional runOnTransientConnection

                                        runOnTransientConnection?: boolean

                                        Opt-in to running over a transient connection - one that has time/data limits +

                                        Optional maxOutboundStreams

                                        maxOutboundStreams?: number

                                        How many outgoing streams can be open for this protocol at the same time on each connection (default: 64)

                                        +

                                        Optional runOnTransientConnection

                                        runOnTransientConnection?: boolean

                                        Opt-in to running over a transient connection - one that has time/data limits placed on it.

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        maxInboundStreamsmaxOutboundStreamsrunOnTransientConnection
                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        maxInboundStreamsmaxOutboundStreamsrunOnTransientConnection
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamHandlerRecord.html b/interfaces/_libp2p_interface.StreamHandlerRecord.html index e87bdd86ec..4e8a7cd855 100644 --- a/interfaces/_libp2p_interface.StreamHandlerRecord.html +++ b/interfaces/_libp2p_interface.StreamHandlerRecord.html @@ -1,3 +1,3 @@ -StreamHandlerRecord | libp2p

                                        Interface StreamHandlerRecord

                                        interface StreamHandlerRecord {
                                            handler: StreamHandler;
                                            options: StreamHandlerOptions;
                                        }

                                        Properties

                                        handler +StreamHandlerRecord | libp2p

                                        Interface StreamHandlerRecord

                                        interface StreamHandlerRecord {
                                            handler: StreamHandler;
                                            options: StreamHandlerOptions;
                                        }

                                        Properties

                                        handler options -

                                        Properties

                                        handler

                                        handler: StreamHandler

                                        options

                                        options: StreamHandlerOptions

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        handleroptions
                                        \ No newline at end of file +

                                        Properties

                                        handler

                                        handler: StreamHandler

                                        options

                                        options: StreamHandlerOptions

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        handleroptions
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxer.html b/interfaces/_libp2p_interface.StreamMuxer.html index eb96ea835e..54c5a9fc02 100644 --- a/interfaces/_libp2p_interface.StreamMuxer.html +++ b/interfaces/_libp2p_interface.StreamMuxer.html @@ -1,5 +1,5 @@ StreamMuxer | libp2p

                                        Interface StreamMuxer

                                        A libp2p stream muxer

                                        -
                                        interface StreamMuxer {
                                            protocol: string;
                                            sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                            source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                            streams: Stream[];
                                            abort(err): void;
                                            close(options?): Promise<void>;
                                            newStream(name?): Stream | Promise<Stream>;
                                        }

                                        Hierarchy

                                        Properties

                                        protocol +
                                        interface StreamMuxer {
                                            protocol: string;
                                            sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>;
                                            source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>;
                                            streams: Stream[];
                                            abort(err): void;
                                            close(options?): Promise<void>;
                                            newStream(name?): Stream | Promise<Stream>;
                                        }

                                        Hierarchy

                                        Properties

                                        protocol sink source streams @@ -7,9 +7,9 @@ close newStream

                                        Properties

                                        protocol

                                        protocol: string

                                        The protocol used to select this muxer during connection opening

                                        -

                                        sink

                                        sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                        source

                                        source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                        Readonly streams

                                        streams: Stream[]

                                        A list of streams that are currently open. Closed streams will not be returned.

                                        -

                                        Methods

                                        abort

                                        close

                                        newStream

                                        sink

                                        sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>, unknown>

                                        source

                                        source: AsyncGenerator<Uint8Array | Uint8ArrayList, any, unknown>

                                        Readonly streams

                                        streams: Stream[]

                                        A list of streams that are currently open. Closed streams will not be returned.

                                        +

                                        Methods

                                        abort

                                        close

                                        newStream

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        protocolsinksourcestreamsabortclosenewStream
                                        \ No newline at end of file +

                                        Parameters

                                        • Optional name: string

                                        Returns Stream | Promise<Stream>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        protocolsinksourcestreamsabortclosenewStream
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxerFactory.html b/interfaces/_libp2p_interface.StreamMuxerFactory.html index 60523546e1..3591f556e8 100644 --- a/interfaces/_libp2p_interface.StreamMuxerFactory.html +++ b/interfaces/_libp2p_interface.StreamMuxerFactory.html @@ -1,5 +1,5 @@ -StreamMuxerFactory | libp2p

                                        Interface StreamMuxerFactory

                                        interface StreamMuxerFactory {
                                            protocol: string;
                                            createStreamMuxer(init?): StreamMuxer;
                                        }

                                        Properties

                                        protocol +StreamMuxerFactory | libp2p

                                        Interface StreamMuxerFactory

                                        interface StreamMuxerFactory {
                                            protocol: string;
                                            createStreamMuxer(init?): StreamMuxer;
                                        }

                                        Properties

                                        protocol

                                        Methods

                                        createStreamMuxer

                                        Properties

                                        protocol

                                        protocol: string

                                        The protocol used to select this muxer during connection opening

                                        -

                                        Methods

                                        createStreamMuxer

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        protocolcreateStreamMuxer
                                        \ No newline at end of file +

                                        Methods

                                        createStreamMuxer

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        protocolcreateStreamMuxer
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamMuxerInit.html b/interfaces/_libp2p_interface.StreamMuxerInit.html index 03fc9a4513..7f86001f94 100644 --- a/interfaces/_libp2p_interface.StreamMuxerInit.html +++ b/interfaces/_libp2p_interface.StreamMuxerInit.html @@ -1,7 +1,7 @@ -StreamMuxerInit | libp2p

                                        Interface StreamMuxerInit

                                        interface StreamMuxerInit {
                                            direction?: Direction;
                                            onIncomingStream?(stream): void;
                                            onStreamEnd?(stream): void;
                                        }

                                        Properties

                                        direction? +StreamMuxerInit | libp2p

                                        Interface StreamMuxerInit

                                        interface StreamMuxerInit {
                                            direction?: Direction;
                                            onIncomingStream?(stream): void;
                                            onStreamEnd?(stream): void;
                                        }

                                        Properties

                                        direction?

                                        Methods

                                        onIncomingStream? onStreamEnd?

                                        Properties

                                        Optional direction

                                        direction?: Direction

                                        Outbound stream muxers are opened by the local node, inbound stream muxers are opened by the remote

                                        -

                                        Methods

                                        Optional onIncomingStream

                                        Optional onStreamEnd

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        directiononIncomingStreamonStreamEnd
                                        \ No newline at end of file +

                                        Methods

                                        Optional onIncomingStream

                                        Optional onStreamEnd

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        directiononIncomingStreamonStreamEnd
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.StreamTimeline.html b/interfaces/_libp2p_interface.StreamTimeline.html index 2adaae918d..6398eece46 100644 --- a/interfaces/_libp2p_interface.StreamTimeline.html +++ b/interfaces/_libp2p_interface.StreamTimeline.html @@ -1,13 +1,13 @@ -StreamTimeline | libp2p

                                        Interface StreamTimeline

                                        interface StreamTimeline {
                                            abort?: number;
                                            close?: number;
                                            closeRead?: number;
                                            closeWrite?: number;
                                            open: number;
                                            reset?: number;
                                        }

                                        Properties

                                        abort? +StreamTimeline | libp2p

                                        Interface StreamTimeline

                                        interface StreamTimeline {
                                            abort?: number;
                                            close?: number;
                                            closeRead?: number;
                                            closeWrite?: number;
                                            open: number;
                                            reset?: number;
                                        }

                                        Properties

                                        abort? close? closeRead? closeWrite? open reset?

                                        Properties

                                        Optional abort

                                        abort?: number

                                        A timestamp of when the stream was aborted

                                        -

                                        Optional close

                                        close?: number

                                        A timestamp of when the stream was closed for both reading and writing

                                        -

                                        Optional closeRead

                                        closeRead?: number

                                        A timestamp of when the stream was closed for reading

                                        -

                                        Optional closeWrite

                                        closeWrite?: number

                                        A timestamp of when the stream was closed for writing

                                        -

                                        open

                                        open: number

                                        A timestamp of when the stream was opened

                                        -

                                        Optional reset

                                        reset?: number

                                        A timestamp of when the stream was reset

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        abortclosecloseReadcloseWriteopenreset
                                        \ No newline at end of file +

                                        Optional close

                                        close?: number

                                        A timestamp of when the stream was closed for both reading and writing

                                        +

                                        Optional closeRead

                                        closeRead?: number

                                        A timestamp of when the stream was closed for reading

                                        +

                                        Optional closeWrite

                                        closeWrite?: number

                                        A timestamp of when the stream was closed for writing

                                        +

                                        open

                                        open: number

                                        A timestamp of when the stream was opened

                                        +

                                        Optional reset

                                        reset?: number

                                        A timestamp of when the stream was reset

                                        +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        abortclosecloseReadcloseWriteopenreset
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.SubscriptionChangeData.html b/interfaces/_libp2p_interface.SubscriptionChangeData.html index 7b8285fd31..af758a6fe6 100644 --- a/interfaces/_libp2p_interface.SubscriptionChangeData.html +++ b/interfaces/_libp2p_interface.SubscriptionChangeData.html @@ -1,3 +1,3 @@ -SubscriptionChangeData | libp2p

                                        Interface SubscriptionChangeData

                                        interface SubscriptionChangeData {
                                            peerId: PeerId;
                                            subscriptions: Subscription[];
                                        }

                                        Properties

                                        peerId +SubscriptionChangeData | libp2p

                                        Interface SubscriptionChangeData

                                        interface SubscriptionChangeData {
                                            peerId: PeerId;
                                            subscriptions: Subscription[];
                                        }

                                        Properties

                                        peerId subscriptions -

                                        Properties

                                        peerId

                                        peerId: PeerId

                                        subscriptions

                                        subscriptions: Subscription[]

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        peerIdsubscriptions
                                        \ No newline at end of file +

                                        Properties

                                        peerId

                                        peerId: PeerId

                                        subscriptions

                                        subscriptions: Subscription[]

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        peerIdsubscriptions
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Tag.html b/interfaces/_libp2p_interface.Tag.html index 31dd75a3dc..7425a7f381 100644 --- a/interfaces/_libp2p_interface.Tag.html +++ b/interfaces/_libp2p_interface.Tag.html @@ -1,3 +1,3 @@ -Tag | libp2p

                                        Interface Tag

                                        interface Tag {
                                            value: number;
                                        }

                                        Properties

                                        value +Tag | libp2p

                                        Interface Tag

                                        interface Tag {
                                            value: number;
                                        }

                                        Properties

                                        value

                                        Properties

                                        value

                                        value: number

                                        The tag value

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        value
                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        value
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TagOptions.html b/interfaces/_libp2p_interface.TagOptions.html index fb09c2d543..ce0d99b508 100644 --- a/interfaces/_libp2p_interface.TagOptions.html +++ b/interfaces/_libp2p_interface.TagOptions.html @@ -1,5 +1,5 @@ -TagOptions | libp2p

                                        Interface TagOptions

                                        interface TagOptions {
                                            ttl?: number;
                                            value?: number;
                                        }

                                        Properties

                                        ttl? +TagOptions | libp2p

                                        Interface TagOptions

                                        interface TagOptions {
                                            ttl?: number;
                                            value?: number;
                                        }

                                        Properties

                                        ttl? value?

                                        Properties

                                        Optional ttl

                                        ttl?: number

                                        An optional duration in ms after which the tag will expire

                                        -

                                        Optional value

                                        value?: number

                                        An optional tag value (1-100)

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        ttlvalue
                                        \ No newline at end of file +

                                        Optional value

                                        value?: number

                                        An optional tag value (1-100)

                                        +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        ttlvalue
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TopicValidatorFn.html b/interfaces/_libp2p_interface.TopicValidatorFn.html index c8b76195ff..f16e428a02 100644 --- a/interfaces/_libp2p_interface.TopicValidatorFn.html +++ b/interfaces/_libp2p_interface.TopicValidatorFn.html @@ -1 +1 @@ -TopicValidatorFn | libp2p

                                        Interface TopicValidatorFn

                                        interface TopicValidatorFn ((peer, message) => TopicValidatorResult | Promise<TopicValidatorResult>)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file +TopicValidatorFn | libp2p

                                        Interface TopicValidatorFn

                                        interface TopicValidatorFn ((peer, message) => TopicValidatorResult | Promise<TopicValidatorResult>)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Topology.html b/interfaces/_libp2p_interface.Topology.html index d67359d9d5..2027f787f7 100644 --- a/interfaces/_libp2p_interface.Topology.html +++ b/interfaces/_libp2p_interface.Topology.html @@ -2,18 +2,18 @@ complete network.

                                        It is a way to be notified when peers that support a given protocol connect to or disconnect from the current node.

                                        -
                                        interface Topology {
                                            filter?: TopologyFilter;
                                            notifyOnTransient?: boolean;
                                            onConnect?(peerId, conn): void;
                                            onDisconnect?(peerId): void;
                                        }

                                        Properties

                                        filter? +
                                        interface Topology {
                                            filter?: TopologyFilter;
                                            notifyOnTransient?: boolean;
                                            onConnect?(peerId, conn): void;
                                            onDisconnect?(peerId): void;
                                        }

                                        Properties

                                        filter? notifyOnTransient?

                                        Methods

                                        onConnect? onDisconnect?

                                        Properties

                                        Optional filter

                                        filter?: TopologyFilter

                                        An optional filter can prevent duplicate topology notifications for the same peer.

                                        -

                                        Optional notifyOnTransient

                                        notifyOnTransient?: boolean

                                        If true, invoke onConnect for this topology on transient (e.g. short-lived +

                                        Optional notifyOnTransient

                                        notifyOnTransient?: boolean

                                        If true, invoke onConnect for this topology on transient (e.g. short-lived and/or data-limited) connections

                                        Default

                                        false
                                        -

                                        Methods

                                        Optional onConnect

                                        Methods

                                        Optional onConnect

                                        Optional onDisconnect

                                        Optional onDisconnect

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        filternotifyOnTransientonConnectonDisconnect
                                        \ No newline at end of file +

                                        Parameters

                                        Returns void

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        filternotifyOnTransientonConnectonDisconnect
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TopologyFilter.html b/interfaces/_libp2p_interface.TopologyFilter.html index 6300bc685d..26d5c1cbf7 100644 --- a/interfaces/_libp2p_interface.TopologyFilter.html +++ b/interfaces/_libp2p_interface.TopologyFilter.html @@ -1,6 +1,6 @@ TopologyFilter | libp2p

                                        Interface TopologyFilter

                                        A topology filter

                                        See

                                        https://libp2p.github.io/js-libp2p/functions/_libp2p_peer_collections.peerFilter-1.html

                                        -
                                        interface TopologyFilter {
                                            add(peerId): void;
                                            has(peerId): boolean;
                                            remove(peerId): void;
                                        }

                                        Methods

                                        add +
                                        interface TopologyFilter {
                                            add(peerId): void;
                                            has(peerId): boolean;
                                            remove(peerId): void;
                                        }

                                        Methods

                                        add has remove -

                                        Methods

                                        add

                                        has

                                        remove

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addhasremove
                                        \ No newline at end of file +

                                        Methods

                                        add

                                        has

                                        remove

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addhasremove
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Transport.html b/interfaces/_libp2p_interface.Transport.html index 1db8f369bc..79e9b79d29 100644 --- a/interfaces/_libp2p_interface.Transport.html +++ b/interfaces/_libp2p_interface.Transport.html @@ -1,16 +1,16 @@ Transport | libp2p

                                        Interface Transport<DialEvents>

                                        A libp2p transport offers dial and listen methods to establish connections.

                                        -
                                        interface Transport<DialEvents> {
                                            [toStringTag]: string;
                                            [transportSymbol]: true;
                                            dialFilter: MultiaddrFilter;
                                            listenFilter: MultiaddrFilter;
                                            createListener(options): Listener;
                                            dial(ma, options): Promise<Connection>;
                                        }

                                        Type Parameters

                                        Properties

                                        [toStringTag] +
                                        interface Transport<DialEvents> {
                                            [toStringTag]: string;
                                            [transportSymbol]: true;
                                            dialFilter: MultiaddrFilter;
                                            listenFilter: MultiaddrFilter;
                                            createListener(options): Listener;
                                            dial(ma, options): Promise<Connection>;
                                        }

                                        Type Parameters

                                        Properties

                                        [toStringTag] [transportSymbol] dialFilter listenFilter

                                        Methods

                                        createListener dial

                                        Properties

                                        [toStringTag]

                                        [toStringTag]: string

                                        Used to identify the transport

                                        -

                                        [transportSymbol]

                                        [transportSymbol]: true

                                        Used by the isTransport function

                                        -

                                        dialFilter

                                        dialFilter: MultiaddrFilter

                                        Takes a list of Multiaddrs and returns only addresses that are vali for +

                                        [transportSymbol]

                                        [transportSymbol]: true

                                        Used by the isTransport function

                                        +

                                        dialFilter

                                        dialFilter: MultiaddrFilter

                                        Takes a list of Multiaddrs and returns only addresses that are vali for the transport to dial

                                        -

                                        listenFilter

                                        listenFilter: MultiaddrFilter

                                        Takes a list of Multiaddrs and returns only addresses that are valid for +

                                        listenFilter

                                        listenFilter: MultiaddrFilter

                                        Takes a list of Multiaddrs and returns only addresses that are valid for the transport to listen on

                                        -

                                        Methods

                                        createListener

                                        dial

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        [toStringTag][transportSymbol]dialFilterlistenFiltercreateListenerdial
                                        \ No newline at end of file +

                                        Methods

                                        createListener

                                        dial

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        [toStringTag][transportSymbol]dialFilterlistenFiltercreateListenerdial
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.TypedEventTarget.html b/interfaces/_libp2p_interface.TypedEventTarget.html index db632402d4..733a0faae3 100644 --- a/interfaces/_libp2p_interface.TypedEventTarget.html +++ b/interfaces/_libp2p_interface.TypedEventTarget.html @@ -3,13 +3,13 @@ https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

                                        -
                                        interface TypedEventTarget<EventMap> {
                                            addEventListener<K>(type, listener, options?): void;
                                            dispatchEvent(event): boolean;
                                            dispatchEvent(event): boolean;
                                            listenerCount(type): number;
                                            removeEventListener<K>(type, listener?, options?): void;
                                            removeEventListener(type, listener?, options?): void;
                                            safeDispatchEvent<Detail>(type, detail): boolean;
                                        }

                                        Type Parameters

                                        • EventMap extends Record<string, any>

                                        Hierarchy (view full)

                                        Implemented by

                                        Methods

                                        addEventListener +
                                        interface TypedEventTarget<EventMap> {
                                            addEventListener<K>(type, listener, options?): void;
                                            dispatchEvent(event): boolean;
                                            dispatchEvent(event): boolean;
                                            listenerCount(type): number;
                                            removeEventListener<K>(type, listener?, options?): void;
                                            removeEventListener(type, listener?, options?): void;
                                            safeDispatchEvent<Detail>(type, detail): boolean;
                                        }

                                        Type Parameters

                                        • EventMap extends Record<string, any>

                                        Hierarchy (view full)

                                        Implemented by

                                        Methods

                                        addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent -

                                        Methods

                                        addEventListener

                                        dispatchEvent

                                        • dispatchEvent(event): boolean

                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                          +

                                        Methods

                                        addEventListener

                                        dispatchEvent

                                        • dispatchEvent(event): boolean

                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                          MDN Reference

                                          Parameters

                                          Returns boolean

                                        • dispatchEvent(event): boolean

                                        • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                          MDN Reference

                                          -

                                          Parameters

                                          Returns boolean

                                        listenerCount

                                        removeEventListener

                                        safeDispatchEvent

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                        \ No newline at end of file +

                                        Parameters

                                        Returns boolean

                                        listenerCount

                                        removeEventListener

                                        safeDispatchEvent

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addEventListenerdispatchEventlistenerCountremoveEventListenersafeDispatchEvent
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.URLPeerId.html b/interfaces/_libp2p_interface.URLPeerId.html index 7fadfda365..6a1f8e3101 100644 --- a/interfaces/_libp2p_interface.URLPeerId.html +++ b/interfaces/_libp2p_interface.URLPeerId.html @@ -1,4 +1,4 @@ -URLPeerId | libp2p

                                        Interface URLPeerId

                                        interface URLPeerId {
                                            multihash: MultihashDigest<number>;
                                            privateKey?: Uint8Array;
                                            publicKey?: Uint8Array;
                                            type: "url";
                                            equals(other?): boolean;
                                            toBytes(): Uint8Array;
                                            toCID(): CID<unknown, number, number, Version>;
                                            toString(): string;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        multihash +URLPeerId | libp2p

                                        Interface URLPeerId

                                        interface URLPeerId {
                                            multihash: MultihashDigest<number>;
                                            privateKey?: Uint8Array;
                                            publicKey?: Uint8Array;
                                            type: "url";
                                            equals(other?): boolean;
                                            toBytes(): Uint8Array;
                                            toCID(): CID<unknown, number, number, Version>;
                                            toString(): string;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        multihash privateKey? publicKey? type @@ -6,4 +6,4 @@ toBytes toCID toString -

                                        Properties

                                        multihash

                                        multihash: MultihashDigest<number>

                                        Optional privateKey

                                        privateKey?: Uint8Array

                                        Optional publicKey

                                        publicKey?: Uint8Array

                                        Readonly type

                                        type: "url"

                                        Methods

                                        equals

                                        toBytes

                                        toCID

                                        toString

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                        \ No newline at end of file +

                                        Properties

                                        multihash

                                        multihash: MultihashDigest<number>

                                        Optional privateKey

                                        privateKey?: Uint8Array

                                        Optional publicKey

                                        publicKey?: Uint8Array

                                        Readonly type

                                        type: "url"

                                        Methods

                                        equals

                                        toBytes

                                        toCID

                                        toString

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        multihashprivateKeypublicKeytypeequalstoBytestoCIDtoString
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.UnsignedMessage.html b/interfaces/_libp2p_interface.UnsignedMessage.html index 675b691497..b5c82a8481 100644 --- a/interfaces/_libp2p_interface.UnsignedMessage.html +++ b/interfaces/_libp2p_interface.UnsignedMessage.html @@ -1,4 +1,4 @@ -UnsignedMessage | libp2p

                                        Interface UnsignedMessage

                                        interface UnsignedMessage {
                                            data: Uint8Array;
                                            topic: string;
                                            type: "unsigned";
                                        }

                                        Properties

                                        data +UnsignedMessage | libp2p

                                        Interface UnsignedMessage

                                        interface UnsignedMessage {
                                            data: Uint8Array;
                                            topic: string;
                                            type: "unsigned";
                                        }

                                        Properties

                                        data topic type -

                                        Properties

                                        data

                                        data: Uint8Array

                                        topic

                                        topic: string

                                        type

                                        type: "unsigned"

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        datatopictype
                                        \ No newline at end of file +

                                        Properties

                                        data

                                        data: Uint8Array

                                        topic

                                        topic: string

                                        type

                                        type: "unsigned"

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        datatopictype
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.Upgrader.html b/interfaces/_libp2p_interface.Upgrader.html index 1c4ed4d9f9..8c75b37fc3 100644 --- a/interfaces/_libp2p_interface.Upgrader.html +++ b/interfaces/_libp2p_interface.Upgrader.html @@ -1,5 +1,5 @@ -Upgrader | libp2p

                                        Interface Upgrader

                                        interface Upgrader {
                                            upgradeInbound(maConn, opts?): Promise<Connection>;
                                            upgradeOutbound(maConn, opts?): Promise<Connection>;
                                        }

                                        Methods

                                        upgradeInbound +Upgrader | libp2p

                                        Interface Upgrader

                                        interface Upgrader {
                                            upgradeInbound(maConn, opts?): Promise<Connection>;
                                            upgradeOutbound(maConn, opts?): Promise<Connection>;
                                        }

                                        Methods

                                        upgradeInbound upgradeOutbound

                                        Methods

                                        upgradeInbound

                                        upgradeOutbound

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        upgradeInboundupgradeOutbound
                                        \ No newline at end of file +

                                        Parameters

                                        Returns Promise<Connection>

                                        upgradeOutbound

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        upgradeInboundupgradeOutbound
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface.UpgraderOptions.html b/interfaces/_libp2p_interface.UpgraderOptions.html index a5c4b3d2f1..f819ee72c2 100644 --- a/interfaces/_libp2p_interface.UpgraderOptions.html +++ b/interfaces/_libp2p_interface.UpgraderOptions.html @@ -1,8 +1,8 @@ -UpgraderOptions | libp2p

                                        Interface UpgraderOptions<ConnectionUpgradeEvents>

                                        interface UpgraderOptions<ConnectionUpgradeEvents> {
                                            muxerFactory?: StreamMuxerFactory;
                                            onProgress?: ((evt) => void);
                                            skipEncryption?: boolean;
                                            skipProtection?: boolean;
                                            transient?: boolean;
                                        }

                                        Type Parameters

                                        Hierarchy

                                        Properties

                                        muxerFactory? +UpgraderOptions | libp2p

                                        Interface UpgraderOptions<ConnectionUpgradeEvents>

                                        interface UpgraderOptions<ConnectionUpgradeEvents> {
                                            muxerFactory?: StreamMuxerFactory;
                                            onProgress?: ((evt) => void);
                                            skipEncryption?: boolean;
                                            skipProtection?: boolean;
                                            transient?: boolean;
                                        }

                                        Type Parameters

                                        Hierarchy

                                        Properties

                                        muxerFactory? onProgress? skipEncryption? skipProtection? transient? -

                                        Properties

                                        Optional muxerFactory

                                        muxerFactory?: StreamMuxerFactory

                                        Optional onProgress

                                        onProgress?: ((evt) => void)

                                        Type declaration

                                        Optional skipEncryption

                                        skipEncryption?: boolean

                                        Optional skipProtection

                                        skipProtection?: boolean

                                        Optional transient

                                        transient?: boolean

                                        The passed MultiaddrConnection has limits place on duration and/or data +

                                        Properties

                                        Optional muxerFactory

                                        muxerFactory?: StreamMuxerFactory

                                        Optional onProgress

                                        onProgress?: ((evt) => void)

                                        Type declaration

                                        Optional skipEncryption

                                        skipEncryption?: boolean

                                        Optional skipProtection

                                        skipProtection?: boolean

                                        Optional transient

                                        transient?: boolean

                                        The passed MultiaddrConnection has limits place on duration and/or data transfer amounts so is not expected to be open for very long.

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        muxerFactoryonProgressskipEncryptionskipProtectiontransient
                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        muxerFactoryonProgressskipEncryptionskipProtectiontransient
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html b/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html index 8964838f70..8d1cf7ce58 100644 --- a/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html +++ b/interfaces/_libp2p_interface_compliance_tests.index.TestSetup.html @@ -1,3 +1,3 @@ -TestSetup | libp2p

                                        Interface TestSetup<T, SetupArgs>

                                        interface TestSetup<T, SetupArgs> {
                                            setup(args?): Promise<T>;
                                            teardown(): Promise<void>;
                                        }

                                        Type Parameters

                                        • T
                                        • SetupArgs = Record<string, unknown>

                                        Methods

                                        setup +TestSetup | libp2p

                                        Interface TestSetup<T, SetupArgs>

                                        interface TestSetup<T, SetupArgs> {
                                            setup(args?): Promise<T>;
                                            teardown(): Promise<void>;
                                        }

                                        Type Parameters

                                        • T
                                        • SetupArgs = Record<string, unknown>

                                        Methods

                                        setup teardown -

                                        Methods

                                        setup

                                        teardown

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        setupteardown
                                        \ No newline at end of file +

                                        Methods

                                        setup

                                        teardown

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        setupteardown
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html index a56087dc1c..2b49748f46 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockNetworkComponents.html @@ -1,7 +1,7 @@ -MockNetworkComponents | libp2p

                                        Interface MockNetworkComponents

                                        interface MockNetworkComponents {
                                            connectionManager: ConnectionManager;
                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            logger: ComponentLogger;
                                            peerId: PeerId;
                                            pubsub?: PubSub<PubSubEvents>;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        connectionManager +MockNetworkComponents | libp2p

                                        Interface MockNetworkComponents

                                        interface MockNetworkComponents {
                                            connectionManager: ConnectionManager;
                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            logger: ComponentLogger;
                                            peerId: PeerId;
                                            pubsub?: PubSub<PubSubEvents>;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        connectionManager events logger peerId pubsub? registrar -

                                        Properties

                                        connectionManager

                                        connectionManager: ConnectionManager

                                        events

                                        events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                        logger

                                        logger: ComponentLogger

                                        peerId

                                        peerId: PeerId

                                        Optional pubsub

                                        pubsub?: PubSub<PubSubEvents>

                                        registrar

                                        registrar: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionManagereventsloggerpeerIdpubsubregistrar
                                        \ No newline at end of file +

                                        Properties

                                        connectionManager

                                        connectionManager: ConnectionManager

                                        events

                                        events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                        logger

                                        logger: ComponentLogger

                                        peerId

                                        peerId: PeerId

                                        Optional pubsub

                                        pubsub?: PubSub<PubSubEvents>

                                        registrar

                                        registrar: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionManagereventsloggerpeerIdpubsubregistrar
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html b/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html index 0d2f6f914f..6b9b22f4f1 100644 --- a/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html +++ b/interfaces/_libp2p_interface_compliance_tests.mocks.MockUpgraderInit.html @@ -1,3 +1,3 @@ -MockUpgraderInit | libp2p

                                        Interface MockUpgraderInit

                                        interface MockUpgraderInit {
                                            events?: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            registrar?: Registrar;
                                        }

                                        Properties

                                        events? +MockUpgraderInit | libp2p

                                        Interface MockUpgraderInit

                                        interface MockUpgraderInit {
                                            events?: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            registrar?: Registrar;
                                        }

                                        Properties

                                        events? registrar? -

                                        Properties

                                        Optional events

                                        events?: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                        Optional registrar

                                        registrar?: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        eventsregistrar
                                        \ No newline at end of file +

                                        Properties

                                        Optional events

                                        events?: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                        Optional registrar

                                        registrar?: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        eventsregistrar
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html index 55cfeb9d87..53b7b7c323 100644 --- a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html +++ b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubArgs.html @@ -1,3 +1,3 @@ -PubSubArgs | libp2p

                                        Interface PubSubArgs

                                        interface PubSubArgs {
                                            components: PubSubComponents;
                                            init: PubSubInit;
                                        }

                                        Properties

                                        components +PubSubArgs | libp2p

                                        Interface PubSubArgs

                                        interface PubSubArgs {
                                            components: PubSubComponents;
                                            init: PubSubInit;
                                        }

                                        Properties

                                        components init -

                                        Properties

                                        components

                                        components: PubSubComponents

                                        init

                                        init: PubSubInit

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        componentsinit
                                        \ No newline at end of file +

                                        Properties

                                        components

                                        components: PubSubComponents

                                        init

                                        init: PubSubInit

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        componentsinit
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html index ec069e87bb..419551f297 100644 --- a/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html +++ b/interfaces/_libp2p_interface_compliance_tests.pubsub.PubSubComponents.html @@ -1,6 +1,6 @@ -PubSubComponents | libp2p

                                        Interface PubSubComponents

                                        interface PubSubComponents {
                                            connectionManager: ConnectionManager;
                                            logger: ComponentLogger;
                                            peerId: PeerId;
                                            pubsub?: PubSub<PubSubEvents>;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        connectionManager +PubSubComponents | libp2p

                                        Interface PubSubComponents

                                        interface PubSubComponents {
                                            connectionManager: ConnectionManager;
                                            logger: ComponentLogger;
                                            peerId: PeerId;
                                            pubsub?: PubSub<PubSubEvents>;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        connectionManager logger peerId pubsub? registrar -

                                        Properties

                                        connectionManager

                                        connectionManager: ConnectionManager

                                        logger

                                        logger: ComponentLogger

                                        peerId

                                        peerId: PeerId

                                        Optional pubsub

                                        pubsub?: PubSub<PubSubEvents>

                                        registrar

                                        registrar: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionManagerloggerpeerIdpubsubregistrar
                                        \ No newline at end of file +

                                        Properties

                                        connectionManager

                                        connectionManager: ConnectionManager

                                        logger

                                        logger: ComponentLogger

                                        peerId

                                        peerId: PeerId

                                        Optional pubsub

                                        pubsub?: PubSub<PubSubEvents>

                                        registrar

                                        registrar: Registrar

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionManagerloggerpeerIdpubsubregistrar
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.transport.Connector.html b/interfaces/_libp2p_interface_compliance_tests.transport.Connector.html index e62f2407fc..aa0534c6b1 100644 --- a/interfaces/_libp2p_interface_compliance_tests.transport.Connector.html +++ b/interfaces/_libp2p_interface_compliance_tests.transport.Connector.html @@ -1,3 +1,3 @@ -Connector | libp2p

                                        Interface Connector

                                        interface Connector {
                                            delay(ms): void;
                                            restore(): void;
                                        }

                                        Methods

                                        delay +Connector | libp2p

                                        Interface Connector

                                        interface Connector {
                                            delay(ms): void;
                                            restore(): void;
                                        }

                                        Methods

                                        delay restore -

                                        Methods

                                        delay

                                        restore

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        delayrestore
                                        \ No newline at end of file +

                                        Methods

                                        delay

                                        restore

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        delayrestore
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html b/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html index 9b29616519..76ed1f39d7 100644 --- a/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html +++ b/interfaces/_libp2p_interface_compliance_tests.transport.TransportTestFixtures.html @@ -1,6 +1,6 @@ -TransportTestFixtures | libp2p

                                        Interface TransportTestFixtures

                                        interface TransportTestFixtures {
                                            connector: Connector;
                                            dialAddrs: Multiaddr[];
                                            dialer: Transport<ProgressEvent<any, unknown>>;
                                            listenAddrs: Multiaddr[];
                                            listener: Transport<ProgressEvent<any, unknown>>;
                                        }

                                        Properties

                                        connector +TransportTestFixtures | libp2p

                                        Interface TransportTestFixtures

                                        interface TransportTestFixtures {
                                            connector: Connector;
                                            dialAddrs: Multiaddr[];
                                            dialer: Transport<ProgressEvent<any, unknown>>;
                                            listenAddrs: Multiaddr[];
                                            listener: Transport<ProgressEvent<any, unknown>>;
                                        }

                                        Properties

                                        connector dialAddrs dialer listenAddrs listener -

                                        Properties

                                        connector

                                        connector: Connector

                                        dialAddrs

                                        dialAddrs: Multiaddr[]

                                        dialer

                                        dialer: Transport<ProgressEvent<any, unknown>>

                                        listenAddrs

                                        listenAddrs: Multiaddr[]

                                        listener

                                        listener: Transport<ProgressEvent<any, unknown>>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectordialAddrsdialerlistenAddrslistener
                                        \ No newline at end of file +

                                        Properties

                                        connector

                                        connector: Connector

                                        dialAddrs

                                        dialAddrs: Multiaddr[]

                                        dialer

                                        dialer: Transport<ProgressEvent<any, unknown>>

                                        listenAddrs

                                        listenAddrs: Multiaddr[]

                                        listener

                                        listener: Transport<ProgressEvent<any, unknown>>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectordialAddrsdialerlistenAddrslistener
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.AddressManager.html b/interfaces/_libp2p_interface_internal.AddressManager.html index df2ee4802d..bd38cc0294 100644 --- a/interfaces/_libp2p_interface_internal.AddressManager.html +++ b/interfaces/_libp2p_interface_internal.AddressManager.html @@ -1,4 +1,4 @@ -AddressManager | libp2p

                                        Interface AddressManager

                                        interface AddressManager {
                                            addObservedAddr(addr): void;
                                            confirmObservedAddr(addr): void;
                                            getAddresses(): Multiaddr[];
                                            getAnnounceAddrs(): Multiaddr[];
                                            getListenAddrs(): Multiaddr[];
                                            getObservedAddrs(): Multiaddr[];
                                            removeObservedAddr(addr): void;
                                        }

                                        Methods

                                        addObservedAddr +AddressManager | libp2p

                                        Interface AddressManager

                                        interface AddressManager {
                                            addObservedAddr(addr): void;
                                            confirmObservedAddr(addr): void;
                                            getAddresses(): Multiaddr[];
                                            getAnnounceAddrs(): Multiaddr[];
                                            getListenAddrs(): Multiaddr[];
                                            getObservedAddrs(): Multiaddr[];
                                            removeObservedAddr(addr): void;
                                        }

                                        Methods

                                        addObservedAddr confirmObservedAddr getAddresses getAnnounceAddrs @@ -8,13 +8,13 @@

                                        Methods

                                        addObservedAddr

                                        confirmObservedAddr

                                        confirmObservedAddr

                                        getAddresses

                                        getAnnounceAddrs

                                        getListenAddrs

                                        getObservedAddrs

                                        getAddresses

                                        getAnnounceAddrs

                                        getListenAddrs

                                        getObservedAddrs

                                        removeObservedAddr

                                        removeObservedAddr

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addObservedAddrconfirmObservedAddrgetAddressesgetAnnounceAddrsgetListenAddrsgetObservedAddrsremoveObservedAddr
                                        \ No newline at end of file +

                                        Parameters

                                        Returns void

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        addObservedAddrconfirmObservedAddrgetAddressesgetAnnounceAddrsgetListenAddrsgetObservedAddrsremoveObservedAddr
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.ConnectionManager.html b/interfaces/_libp2p_interface_internal.ConnectionManager.html index 5467ce8ab1..980420effc 100644 --- a/interfaces/_libp2p_interface_internal.ConnectionManager.html +++ b/interfaces/_libp2p_interface_internal.ConnectionManager.html @@ -1,4 +1,4 @@ -ConnectionManager | libp2p

                                        Interface ConnectionManager

                                        interface ConnectionManager {
                                            acceptIncomingConnection(maConn): Promise<boolean>;
                                            afterUpgradeInbound(): void;
                                            closeConnections(peer, options?): Promise<void>;
                                            getConnections(peerId?): Connection[];
                                            getConnectionsMap(): PeerMap<Connection[]>;
                                            getDialQueue(): PendingDial[];
                                            isDialable(multiaddr, options?): Promise<boolean>;
                                            openConnection(peer, options?): Promise<Connection>;
                                        }

                                        Methods

                                        acceptIncomingConnection +ConnectionManager | libp2p

                                        Interface ConnectionManager

                                        interface ConnectionManager {
                                            acceptIncomingConnection(maConn): Promise<boolean>;
                                            afterUpgradeInbound(): void;
                                            closeConnections(peer, options?): Promise<void>;
                                            getConnections(peerId?): Connection[];
                                            getConnectionsMap(): PeerMap<Connection[]>;
                                            getDialQueue(): PendingDial[];
                                            isDialable(multiaddr, options?): Promise<boolean>;
                                            openConnection(peer, options?): Promise<Connection>;
                                        }

                                        Methods

                                        acceptIncomingConnection afterUpgradeInbound closeConnections getConnections @@ -10,23 +10,23 @@ exchanged, this lets the ConnectionManager check we have sufficient resources to accept the connection in which case it will return true, otherwise it will return false.

                                        -

                                        Parameters

                                        Returns Promise<boolean>

                                        afterUpgradeInbound

                                        closeConnections

                                        getConnections

                                        afterUpgradeInbound

                                        closeConnections

                                        getConnections

                                        getConnectionsMap

                                        getConnectionsMap

                                        getDialQueue

                                        getDialQueue

                                        isDialable

                                        isDialable

                                        openConnection

                                        openConnection

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        acceptIncomingConnectionafterUpgradeInboundcloseConnectionsgetConnectionsgetConnectionsMapgetDialQueueisDialableopenConnection
                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        acceptIncomingConnectionafterUpgradeInboundcloseConnectionsgetConnectionsgetConnectionsMapgetDialQueueisDialableopenConnection
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Envelope.html b/interfaces/_libp2p_interface_internal.Envelope.html index 1a5d81da58..e884eefab0 100644 --- a/interfaces/_libp2p_interface_internal.Envelope.html +++ b/interfaces/_libp2p_interface_internal.Envelope.html @@ -1,8 +1,8 @@ -Envelope | libp2p

                                        Interface Envelope

                                        interface Envelope {
                                            payload: Uint8Array;
                                            payloadType: Uint8Array | Uint8ArrayList;
                                            peerId: PeerId;
                                            signature: Uint8Array | Uint8ArrayList;
                                            equals(other): boolean;
                                            marshal(): Uint8Array;
                                            validate(domain): Promise<boolean>;
                                        }

                                        Properties

                                        payload +Envelope | libp2p

                                        Interface Envelope

                                        interface Envelope {
                                            payload: Uint8Array;
                                            payloadType: Uint8Array | Uint8ArrayList;
                                            peerId: PeerId;
                                            signature: Uint8Array | Uint8ArrayList;
                                            equals(other): boolean;
                                            marshal(): Uint8Array;
                                            validate(domain): Promise<boolean>;
                                        }

                                        Properties

                                        payload payloadType peerId signature

                                        Methods

                                        equals marshal validate -

                                        Properties

                                        payload

                                        payload: Uint8Array

                                        payloadType

                                        payloadType: Uint8Array | Uint8ArrayList

                                        peerId

                                        peerId: PeerId

                                        signature

                                        signature: Uint8Array | Uint8ArrayList

                                        Methods

                                        equals

                                        marshal

                                        validate

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
                                        \ No newline at end of file +

                                        Properties

                                        payload

                                        payload: Uint8Array

                                        payloadType

                                        payloadType: Uint8Array | Uint8ArrayList

                                        peerId

                                        peerId: PeerId

                                        signature

                                        signature: Uint8Array | Uint8ArrayList

                                        Methods

                                        equals

                                        marshal

                                        validate

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        payloadpayloadTypepeerIdsignatureequalsmarshalvalidate
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.IncomingStreamData.html b/interfaces/_libp2p_interface_internal.IncomingStreamData.html index c88482ef88..bbe2ebe4b8 100644 --- a/interfaces/_libp2p_interface_internal.IncomingStreamData.html +++ b/interfaces/_libp2p_interface_internal.IncomingStreamData.html @@ -1,5 +1,5 @@ -IncomingStreamData | libp2p

                                        Interface IncomingStreamData

                                        interface IncomingStreamData {
                                            connection: Connection;
                                            stream: Stream;
                                        }

                                        Properties

                                        connection +IncomingStreamData | libp2p

                                        Interface IncomingStreamData

                                        interface IncomingStreamData {
                                            connection: Connection;
                                            stream: Stream;
                                        }

                                        Properties

                                        connection stream

                                        Properties

                                        connection

                                        connection: Connection

                                        The connection that the stream was opened on

                                        -

                                        stream

                                        stream: Stream

                                        The stream that has been opened

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionstream
                                        \ No newline at end of file +

                                        stream

                                        stream: Stream

                                        The stream that has been opened

                                        +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        connectionstream
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html b/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html index c4d28266b8..9c1351e62b 100644 --- a/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html +++ b/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html @@ -2,13 +2,13 @@ the optional signal property.

                                        Example

                                        const controller = new AbortController()

                                        aLongRunningOperation({
                                          signal: controller.signal
                                        })

                                        // later

                                        controller.abort()
                                        -
                                        interface OpenConnectionOptions {
                                            force?: boolean;
                                            onProgress?: ((evt) => void);
                                            priority?: number;
                                            signal?: AbortSignal;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        force? +
                                        interface OpenConnectionOptions {
                                            force?: boolean;
                                            onProgress?: ((evt) => void);
                                            priority?: number;
                                            signal?: AbortSignal;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        force? onProgress? priority? signal?

                                        Properties

                                        Optional force

                                        force?: boolean

                                        When opening a connection to a remote peer, if a connection already exists it will be returned instead of creating a new connection. Pass true here to override that and dial a new connection anyway. (default: false)

                                        -

                                        Optional onProgress

                                        onProgress?: ((evt) => void)

                                        Type declaration

                                        Optional priority

                                        priority?: number

                                        Connection requests with a higher priority will be executed before those +

                                        Optional onProgress

                                        onProgress?: ((evt) => void)

                                        Type declaration

                                        Optional priority

                                        priority?: number

                                        Connection requests with a higher priority will be executed before those with a lower priority. (default: 50)

                                        -

                                        Optional signal

                                        signal?: AbortSignal

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        forceonProgressprioritysignal
                                        \ No newline at end of file +

                                        Optional signal

                                        signal?: AbortSignal

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        forceonProgressprioritysignal
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.RandomWalk.html b/interfaces/_libp2p_interface_internal.RandomWalk.html index 0f4abad5c2..afc83e3a36 100644 --- a/interfaces/_libp2p_interface_internal.RandomWalk.html +++ b/interfaces/_libp2p_interface_internal.RandomWalk.html @@ -1,6 +1,6 @@ RandomWalk | libp2p

                                        Interface RandomWalk

                                        RandomWalk finds random peers on the network and dials them. Use this after registering a Topology if you need to discover common network services.

                                        -
                                        interface RandomWalk {
                                            walk(options?): AsyncGenerator<PeerInfo, any, unknown>;
                                        }

                                        Methods

                                        walk +
                                        interface RandomWalk {
                                            walk(options?): AsyncGenerator<PeerInfo, any, unknown>;
                                        }

                                        Methods

                                        walk

                                        Methods

                                        walk

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        walk
                                        \ No newline at end of file +

                                        Parameters

                                        Returns AsyncGenerator<PeerInfo, any, unknown>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        walk
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Record.html b/interfaces/_libp2p_interface_internal.Record.html index b25d04ef09..02fc546619 100644 --- a/interfaces/_libp2p_interface_internal.Record.html +++ b/interfaces/_libp2p_interface_internal.Record.html @@ -1,10 +1,10 @@ Record | libp2p

                                        Interface Record

                                        Record is the base implementation of a record that can be used as the payload of a libp2p envelope.

                                        -
                                        interface Record {
                                            codec: Uint8Array;
                                            domain: string;
                                            equals(other): boolean;
                                            marshal(): Uint8Array;
                                        }

                                        Properties

                                        codec +
                                        interface Record {
                                            codec: Uint8Array;
                                            domain: string;
                                            equals(other): boolean;
                                            marshal(): Uint8Array;
                                        }

                                        Properties

                                        codec domain

                                        Methods

                                        equals marshal

                                        Properties

                                        codec

                                        codec: Uint8Array

                                        identifier of the type of record

                                        -

                                        domain

                                        domain: string

                                        signature domain.

                                        -

                                        Methods

                                        equals

                                        marshal

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        codecdomainequalsmarshal
                                        \ No newline at end of file +

                                        domain

                                        domain: string

                                        signature domain.

                                        +

                                        Methods

                                        equals

                                        marshal

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        codecdomainequalsmarshal
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.Registrar.html b/interfaces/_libp2p_interface_internal.Registrar.html index b4d1744aa5..f82d7d9e51 100644 --- a/interfaces/_libp2p_interface_internal.Registrar.html +++ b/interfaces/_libp2p_interface_internal.Registrar.html @@ -1,4 +1,4 @@ -Registrar | libp2p

                                        Interface Registrar

                                        interface Registrar {
                                            getHandler(protocol): StreamHandlerRecord;
                                            getProtocols(): string[];
                                            getTopologies(protocol): Topology[];
                                            handle(protocol, handler, options?): Promise<void>;
                                            register(protocol, topology): Promise<string>;
                                            unhandle(protocol): Promise<void>;
                                            unregister(id): void;
                                        }

                                        Methods

                                        getHandler +Registrar | libp2p

                                        Interface Registrar

                                        interface Registrar {
                                            getHandler(protocol): StreamHandlerRecord;
                                            getProtocols(): string[];
                                            getTopologies(protocol): Topology[];
                                            handle(protocol, handler, options?): Promise<void>;
                                            register(protocol, topology): Promise<string>;
                                            unhandle(protocol): Promise<void>;
                                            unregister(id): void;
                                        }

                                        Methods

                                        getHandler getProtocols getTopologies handle @@ -6,15 +6,15 @@ unhandle unregister

                                        Methods

                                        getHandler

                                        getProtocols

                                        getTopologies

                                        getProtocols

                                        getTopologies

                                        handle

                                        register

                                        handle

                                        register

                                        • register(protocol, topology): Promise<string>

                                        • Register a topology handler for a protocol - the topology will be invoked when peers are discovered on the network that support the passed protocol.

                                          An id will be returned that can later be used to unregister the topology.

                                          -

                                          Parameters

                                          Returns Promise<string>

                                        unhandle

                                        unregister

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        getHandlergetProtocolsgetTopologieshandleregisterunhandleunregister
                                        \ No newline at end of file +

                                        Parameters

                                        Returns Promise<string>

                                        unhandle

                                        unregister

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        getHandlergetProtocolsgetTopologieshandleregisterunhandleunregister
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandler.html b/interfaces/_libp2p_interface_internal.StreamHandler.html index 1c6704d049..2c4d16bdf0 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandler.html +++ b/interfaces/_libp2p_interface_internal.StreamHandler.html @@ -1 +1 @@ -StreamHandler | libp2p

                                        Interface StreamHandler

                                        interface StreamHandler ((data) => void)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file +StreamHandler | libp2p

                                        Interface StreamHandler

                                        interface StreamHandler ((data) => void)

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html b/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html index 379807269f..a56c152fbd 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html +++ b/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html @@ -1,9 +1,9 @@ -StreamHandlerOptions | libp2p

                                        Interface StreamHandlerOptions

                                        interface StreamHandlerOptions {
                                            maxInboundStreams?: number;
                                            maxOutboundStreams?: number;
                                            runOnTransientConnection?: boolean;
                                        }

                                        Properties

                                        maxInboundStreams? +StreamHandlerOptions | libp2p

                                        Interface StreamHandlerOptions

                                        interface StreamHandlerOptions {
                                            maxInboundStreams?: number;
                                            maxOutboundStreams?: number;
                                            runOnTransientConnection?: boolean;
                                        }

                                        Properties

                                        maxInboundStreams? maxOutboundStreams? runOnTransientConnection?

                                        Properties

                                        Optional maxInboundStreams

                                        maxInboundStreams?: number

                                        How many incoming streams can be open for this protocol at the same time on each connection (default: 32)

                                        -

                                        Optional maxOutboundStreams

                                        maxOutboundStreams?: number

                                        How many outgoing streams can be open for this protocol at the same time on each connection (default: 64)

                                        -

                                        Optional runOnTransientConnection

                                        runOnTransientConnection?: boolean

                                        If true, allow this protocol to run on limited connections (e.g. +

                                        Optional maxOutboundStreams

                                        maxOutboundStreams?: number

                                        How many outgoing streams can be open for this protocol at the same time on each connection (default: 64)

                                        +

                                        Optional runOnTransientConnection

                                        runOnTransientConnection?: boolean

                                        If true, allow this protocol to run on limited connections (e.g. connections with data or duration limits such as circuit relay connections) (default: false)

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        maxInboundStreamsmaxOutboundStreamsrunOnTransientConnection
                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        maxInboundStreamsmaxOutboundStreamsrunOnTransientConnection
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html b/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html index 61565cca61..f921a7a368 100644 --- a/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html +++ b/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html @@ -1,5 +1,5 @@ -StreamHandlerRecord | libp2p

                                        Interface StreamHandlerRecord

                                        interface StreamHandlerRecord {
                                            handler: StreamHandler;
                                            options: StreamHandlerOptions;
                                        }

                                        Properties

                                        handler +StreamHandlerRecord | libp2p

                                        Interface StreamHandlerRecord

                                        interface StreamHandlerRecord {
                                            handler: StreamHandler;
                                            options: StreamHandlerOptions;
                                        }

                                        Properties

                                        handler options

                                        Properties

                                        handler

                                        handler: StreamHandler

                                        The handler that was registered to handle streams opened on the protocol

                                        -

                                        options

                                        options: StreamHandlerOptions

                                        The options that were used to register the stream handler

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        handleroptions
                                        \ No newline at end of file +

                                        options

                                        options: StreamHandlerOptions

                                        The options that were used to register the stream handler

                                        +

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        handleroptions
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.TransportManager.html b/interfaces/_libp2p_interface_internal.TransportManager.html index b2e1b59960..593e1618e0 100644 --- a/interfaces/_libp2p_interface_internal.TransportManager.html +++ b/interfaces/_libp2p_interface_internal.TransportManager.html @@ -1,4 +1,4 @@ -TransportManager | libp2p

                                        Interface TransportManager

                                        interface TransportManager {
                                            add(transport): void;
                                            dial(ma, options?): Promise<Connection>;
                                            dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                            getAddrs(): Multiaddr[];
                                            getListeners(): Listener[];
                                            getTransports(): Transport<ProgressEvent<any, unknown>>[];
                                            listen(addrs): Promise<void>;
                                            listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                            remove(key): Promise<void>;
                                            removeAll(): Promise<void>;
                                        }

                                        Methods

                                        add +TransportManager | libp2p

                                        Interface TransportManager

                                        interface TransportManager {
                                            add(transport): void;
                                            dial(ma, options?): Promise<Connection>;
                                            dialTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                            getAddrs(): Multiaddr[];
                                            getListeners(): Listener[];
                                            getTransports(): Transport<ProgressEvent<any, unknown>>[];
                                            listen(addrs): Promise<void>;
                                            listenTransportForMultiaddr(ma): undefined | Transport<ProgressEvent<any, unknown>>;
                                            remove(key): Promise<void>;
                                            removeAll(): Promise<void>;
                                        }

                                        Methods

                                        add dial dialTransportForMultiaddr getAddrs @@ -9,17 +9,17 @@ remove removeAll

                                        Methods

                                        add

                                        dial

                                        dial

                                        dialTransportForMultiaddr

                                        getAddrs

                                        getListeners

                                        getTransports

                                        listen

                                        listenTransportForMultiaddr

                                        dialTransportForMultiaddr

                                        getAddrs

                                        getListeners

                                        getTransports

                                        listen

                                        listenTransportForMultiaddr

                                        remove

                                        removeAll

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        adddialdialTransportForMultiaddrgetAddrsgetListenersgetTransportslistenlistenTransportForMultiaddrremoveremoveAll
                                        \ No newline at end of file +

                                        Parameters

                                        Returns undefined | Transport<ProgressEvent<any, unknown>>

                                        remove

                                        removeAll

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        adddialdialTransportForMultiaddrgetAddrsgetListenersgetTransportslistenlistenTransportForMultiaddrremoveremoveAll
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html b/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html index f5f607e370..047c17b1eb 100644 --- a/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html +++ b/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                        Example

                                        const controller = new AbortController()

                                        aLongRunningOperation({
                                          signal: controller.signal
                                        })

                                        // later

                                        controller.abort()
                                        -
                                        interface TransportManagerDialOptions {
                                            onProgress?: ((evt) => void);
                                            signal?: AbortSignal;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        onProgress? +
                                        interface TransportManagerDialOptions {
                                            onProgress?: ((evt) => void);
                                            signal?: AbortSignal;
                                        }

                                        Hierarchy (view full)

                                        Properties

                                        onProgress? signal?

                                        Properties

                                        Optional onProgress

                                        onProgress?: ((evt) => void)

                                        Type declaration

                                        Optional signal

                                        signal?: AbortSignal

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        onProgresssignal
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.AddPeerEvent.html b/interfaces/_libp2p_kad_dht.AddPeerEvent.html index 0e4f734cf8..aa1dbb70ea 100644 --- a/interfaces/_libp2p_kad_dht.AddPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.AddPeerEvent.html @@ -1,5 +1,5 @@ AddPeerEvent | libp2p

                                        Interface AddPeerEvent

                                        Emitted when peers are added to a query

                                        -
                                        interface AddPeerEvent {
                                            name: "ADD_PEER";
                                            peer: PeerId;
                                            type: ADD_PEER;
                                        }

                                        Properties

                                        name +
                                        interface AddPeerEvent {
                                            name: "ADD_PEER";
                                            peer: PeerId;
                                            type: ADD_PEER;
                                        }

                                        Properties

                                        name peer type -

                                        Properties

                                        name

                                        name: "ADD_PEER"

                                        peer

                                        peer: PeerId

                                        type

                                        type: ADD_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        namepeertype
                                        \ No newline at end of file +

                                        Properties

                                        name

                                        name: "ADD_PEER"

                                        peer

                                        peer: PeerId

                                        type

                                        type: ADD_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        namepeertype
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.DHTRecord.html b/interfaces/_libp2p_kad_dht.DHTRecord.html index 55740f7ebf..ce0627ef4c 100644 --- a/interfaces/_libp2p_kad_dht.DHTRecord.html +++ b/interfaces/_libp2p_kad_dht.DHTRecord.html @@ -1,4 +1,4 @@ -DHTRecord | libp2p

                                        Interface DHTRecord

                                        interface DHTRecord {
                                            key: Uint8Array;
                                            timeReceived?: Date;
                                            value: Uint8Array;
                                        }

                                        Properties

                                        key +DHTRecord | libp2p

                                        Interface DHTRecord

                                        interface DHTRecord {
                                            key: Uint8Array;
                                            timeReceived?: Date;
                                            value: Uint8Array;
                                        }

                                        Properties

                                        key timeReceived? value -

                                        Properties

                                        key

                                        key: Uint8Array

                                        Optional timeReceived

                                        timeReceived?: Date

                                        value

                                        value: Uint8Array

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        keytimeReceivedvalue
                                        \ No newline at end of file +

                                        Properties

                                        key

                                        key: Uint8Array

                                        Optional timeReceived

                                        timeReceived?: Date

                                        value

                                        value: Uint8Array

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        keytimeReceivedvalue
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.DialPeerEvent.html b/interfaces/_libp2p_kad_dht.DialPeerEvent.html index e0b0263956..4ff26b6cbc 100644 --- a/interfaces/_libp2p_kad_dht.DialPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.DialPeerEvent.html @@ -1,5 +1,5 @@ DialPeerEvent | libp2p

                                        Interface DialPeerEvent

                                        Emitted when peers are dialled as part of a query

                                        -
                                        interface DialPeerEvent {
                                            name: "DIAL_PEER";
                                            peer: PeerId;
                                            type: DIAL_PEER;
                                        }

                                        Properties

                                        name +
                                        interface DialPeerEvent {
                                            name: "DIAL_PEER";
                                            peer: PeerId;
                                            type: DIAL_PEER;
                                        }

                                        Properties

                                        name peer type -

                                        Properties

                                        name

                                        name: "DIAL_PEER"

                                        peer

                                        peer: PeerId

                                        type

                                        type: DIAL_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        namepeertype
                                        \ No newline at end of file +

                                        Properties

                                        name

                                        name: "DIAL_PEER"

                                        peer

                                        peer: PeerId

                                        type

                                        type: DIAL_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        namepeertype
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.FinalPeerEvent.html b/interfaces/_libp2p_kad_dht.FinalPeerEvent.html index 8199f0a165..1875d8a7fa 100644 --- a/interfaces/_libp2p_kad_dht.FinalPeerEvent.html +++ b/interfaces/_libp2p_kad_dht.FinalPeerEvent.html @@ -1,6 +1,6 @@ FinalPeerEvent | libp2p

                                        Interface FinalPeerEvent

                                        Emitted at the end of a findPeer query

                                        -
                                        interface FinalPeerEvent {
                                            from: PeerId;
                                            name: "FINAL_PEER";
                                            peer: PeerInfo;
                                            type: FINAL_PEER;
                                        }

                                        Properties

                                        from +
                                        interface FinalPeerEvent {
                                            from: PeerId;
                                            name: "FINAL_PEER";
                                            peer: PeerInfo;
                                            type: FINAL_PEER;
                                        }

                                        Properties

                                        from name peer type -

                                        Properties

                                        from

                                        from: PeerId

                                        name

                                        name: "FINAL_PEER"

                                        peer

                                        peer: PeerInfo

                                        type

                                        type: FINAL_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        fromnamepeertype
                                        \ No newline at end of file +

                                        Properties

                                        from

                                        from: PeerId

                                        name

                                        name: "FINAL_PEER"

                                        peer

                                        peer: PeerInfo

                                        type

                                        type: FINAL_PEER

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        fromnamepeertype
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHT.html b/interfaces/_libp2p_kad_dht.KadDHT.html index 110ae59bac..e5b3fa81f0 100644 --- a/interfaces/_libp2p_kad_dht.KadDHT.html +++ b/interfaces/_libp2p_kad_dht.KadDHT.html @@ -1,4 +1,4 @@ -KadDHT | libp2p

                                        Interface KadDHT

                                        interface KadDHT {
                                            findPeer(id, options?): AsyncIterable<QueryEvent>;
                                            findProviders(key, options?): AsyncIterable<QueryEvent>;
                                            get(key, options?): AsyncIterable<QueryEvent>;
                                            getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                            getMode(): "client" | "server";
                                            provide(key, options?): AsyncIterable<QueryEvent>;
                                            put(key, value, options?): AsyncIterable<QueryEvent>;
                                            refreshRoutingTable(): Promise<void>;
                                            setMode(mode): Promise<void>;
                                        }

                                        Hierarchy (view full)

                                        Methods

                                        findPeer +KadDHT | libp2p

                                        Interface KadDHT

                                        interface KadDHT {
                                            findPeer(id, options?): AsyncIterable<QueryEvent>;
                                            findProviders(key, options?): AsyncIterable<QueryEvent>;
                                            get(key, options?): AsyncIterable<QueryEvent>;
                                            getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                            getMode(): "client" | "server";
                                            provide(key, options?): AsyncIterable<QueryEvent>;
                                            put(key, value, options?): AsyncIterable<QueryEvent>;
                                            refreshRoutingTable(): Promise<void>;
                                            setMode(mode): Promise<void>;
                                        }

                                        Hierarchy (view full)

                                        Methods

                                        findPeer findProviders get getClosestPeers @@ -8,13 +8,13 @@ refreshRoutingTable setMode

                                        Methods

                                        findPeer

                                        findProviders

                                        get

                                        getClosestPeers

                                        getMode

                                        • getMode(): "client" | "server"

                                        • Returns the mode this node is in

                                          -

                                          Returns "client" | "server"

                                        provide

                                        put

                                        refreshRoutingTable

                                        setMode

                                        findProviders

                                        get

                                        getClosestPeers

                                        getMode

                                        • getMode(): "client" | "server"

                                        • Returns the mode this node is in

                                          +

                                          Returns "client" | "server"

                                        provide

                                        put

                                        refreshRoutingTable

                                        setMode

                                        • setMode(mode): Promise<void>

                                        • If 'server' this node will respond to DHT queries, if 'client' this node will not.

                                          -

                                          Parameters

                                          • mode: "client" | "server"

                                          Returns Promise<void>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        findPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                        \ No newline at end of file +

                                        Parameters

                                        • mode: "client" | "server"

                                        Returns Promise<void>

                                        Settings

                                        Member Visibility

                                        Theme

                                        On This Page

                                        findPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                        \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHTComponents.html b/interfaces/_libp2p_kad_dht.KadDHTComponents.html index 1529f8f884..cd7e78e7f2 100644 --- a/interfaces/_libp2p_kad_dht.KadDHTComponents.html +++ b/interfaces/_libp2p_kad_dht.KadDHTComponents.html @@ -1,4 +1,4 @@ -KadDHTComponents | libp2p

                                        Interface KadDHTComponents

                                        interface KadDHTComponents {
                                            addressManager: AddressManager;
                                            connectionManager: ConnectionManager;
                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            logger: ComponentLogger;
                                            metrics?: Metrics;
                                            peerId: PeerId;
                                            peerStore: PeerStore;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        addressManager +KadDHTComponents | libp2p

                                        Interface KadDHTComponents

                                        interface KadDHTComponents {
                                            addressManager: AddressManager;
                                            connectionManager: ConnectionManager;
                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                            logger: ComponentLogger;
                                            metrics?: Metrics;
                                            peerId: PeerId;
                                            peerStore: PeerStore;
                                            registrar: Registrar;
                                        }

                                        Properties

                                        addressManager connectionManager datastore events @@ -7,4 +7,4 @@ peerId peerStore registrar -

                                        Properties

                                        addressManager

                                        addressManager: AddressManager

                                        connectionManager

                                        connectionManager: ConnectionManager

                                        datastore

                                        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                        Type declaration

                                          Type declaration

                                            Type declaration

                                              Type declaration

                                                Type declaration

                                                  Type declaration

                                                    Type declaration

                                                      Type declaration

                                                        Type declaration

                                                          Type declaration

                                                            events

                                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                            logger

                                                            logger: ComponentLogger

                                                            Optional metrics

                                                            metrics?: Metrics

                                                            peerId

                                                            peerId: PeerId

                                                            peerStore

                                                            peerStore: PeerStore

                                                            registrar

                                                            registrar: Registrar

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            On This Page

                                                            addressManagerconnectionManagerdatastoreeventsloggermetricspeerIdpeerStoreregistrar
                                                            \ No newline at end of file +

                                                            Properties

                                                            addressManager

                                                            addressManager: AddressManager

                                                            connectionManager

                                                            connectionManager: ConnectionManager

                                                            datastore

                                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                            Type declaration

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          Type declaration

                                                                            Type declaration

                                                                              Type declaration

                                                                                events

                                                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                logger

                                                                                logger: ComponentLogger

                                                                                Optional metrics

                                                                                metrics?: Metrics

                                                                                peerId

                                                                                peerId: PeerId

                                                                                peerStore

                                                                                peerStore: PeerStore

                                                                                registrar

                                                                                registrar: Registrar

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                addressManagerconnectionManagerdatastoreeventsloggermetricspeerIdpeerStoreregistrar
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.KadDHTInit.html b/interfaces/_libp2p_kad_dht.KadDHTInit.html index 75310144aa..96f0bdca0d 100644 --- a/interfaces/_libp2p_kad_dht.KadDHTInit.html +++ b/interfaces/_libp2p_kad_dht.KadDHTInit.html @@ -1,4 +1,4 @@ -KadDHTInit | libp2p

                                                                                Interface KadDHTInit

                                                                                interface KadDHTInit {
                                                                                    allowQueryWithZeroPeers?: boolean;
                                                                                    clientMode?: boolean;
                                                                                    initialQuerySelfInterval?: number;
                                                                                    kBucketSize?: number;
                                                                                    kBucketSplitThreshold?: number;
                                                                                    logPrefix?: string;
                                                                                    maxInboundStreams?: number;
                                                                                    maxOutboundStreams?: number;
                                                                                    networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                    pingConcurrency?: number;
                                                                                    pingTimeout?: number;
                                                                                    prefixLength?: number;
                                                                                    protocol?: string;
                                                                                    providers?: ProvidersInit;
                                                                                    querySelfInterval?: number;
                                                                                    selectors?: Selectors;
                                                                                    validators?: Validators;
                                                                                    peerInfoMapper?(peer): PeerInfo;
                                                                                }

                                                                                Properties

                                                                                allowQueryWithZeroPeers? +KadDHTInit | libp2p

                                                                                Interface KadDHTInit

                                                                                interface KadDHTInit {
                                                                                    allowQueryWithZeroPeers?: boolean;
                                                                                    clientMode?: boolean;
                                                                                    initialQuerySelfInterval?: number;
                                                                                    kBucketSize?: number;
                                                                                    kBucketSplitThreshold?: number;
                                                                                    logPrefix?: string;
                                                                                    maxInboundStreams?: number;
                                                                                    maxOutboundStreams?: number;
                                                                                    networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">;
                                                                                    pingConcurrency?: number;
                                                                                    pingTimeout?: number;
                                                                                    prefixLength?: number;
                                                                                    protocol?: string;
                                                                                    providers?: ProvidersInit;
                                                                                    querySelfInterval?: number;
                                                                                    selectors?: Selectors;
                                                                                    validators?: Validators;
                                                                                    peerInfoMapper?(peer): PeerInfo;
                                                                                }

                                                                                Properties

                                                                                allowQueryWithZeroPeers? clientMode? initialQuerySelfInterval? kBucketSize? @@ -21,49 +21,49 @@

                                                                                Pass true here to disable this behaviour.

                                                                                Default

                                                                                false
                                                                                -

                                                                                Optional clientMode

                                                                                clientMode?: boolean

                                                                                If true, only ever be a DHT client. If false, be a DHT client until told +

                                                                                Optional clientMode

                                                                                clientMode?: boolean

                                                                                If true, only ever be a DHT client. If false, be a DHT client until told to be a DHT server via setMode.

                                                                                Default

                                                                                false
                                                                                -

                                                                                Optional initialQuerySelfInterval

                                                                                initialQuerySelfInterval?: number

                                                                                During startup we run the self-query at a shorter interval to ensure +

                                                                                Optional initialQuerySelfInterval

                                                                                initialQuerySelfInterval?: number

                                                                                During startup we run the self-query at a shorter interval to ensure the containing node can respond to queries quickly. Set this interval here in ms.

                                                                                Default

                                                                                1000
                                                                                -

                                                                                Optional kBucketSize

                                                                                kBucketSize?: number

                                                                                How many peers to store in each kBucket. Once there are more than this +

                                                                                Optional kBucketSize

                                                                                kBucketSize?: number

                                                                                How many peers to store in each kBucket. Once there are more than this number of peers for a given prefix in a kBucket, the node will start to ping existing peers to see if they are still online - if they are offline they will be evicted and the new peer added.

                                                                                Default

                                                                                20
                                                                                -

                                                                                Optional kBucketSplitThreshold

                                                                                kBucketSplitThreshold?: number

                                                                                The threshold at which a kBucket will be split into two smaller kBuckets.

                                                                                +

                                                                                Optional kBucketSplitThreshold

                                                                                kBucketSplitThreshold?: number

                                                                                The threshold at which a kBucket will be split into two smaller kBuckets.

                                                                                KBuckets will not be split once the maximum trie depth is reached (controlled by the prefixLength option) so one can replicate go-libp2p's accelerated DHT client by (for example) setting kBucketSize to Infinity and kBucketSplitThreshold to 20.

                                                                                Default

                                                                                kBucketSize
                                                                                -

                                                                                Optional logPrefix

                                                                                logPrefix?: string

                                                                                The logging prefix to use

                                                                                +

                                                                                Optional logPrefix

                                                                                logPrefix?: string

                                                                                The logging prefix to use

                                                                                Default

                                                                                "libp2p:kad-dht"
                                                                                -

                                                                                Optional maxInboundStreams

                                                                                maxInboundStreams?: number

                                                                                How many parallel incoming streams to allow on the DHT protocol per +

                                                                                Optional maxInboundStreams

                                                                                maxInboundStreams?: number

                                                                                How many parallel incoming streams to allow on the DHT protocol per connection

                                                                                Default

                                                                                32
                                                                                -

                                                                                Optional maxOutboundStreams

                                                                                maxOutboundStreams?: number

                                                                                How many parallel outgoing streams to allow on the DHT protocol per +

                                                                                Optional maxOutboundStreams

                                                                                maxOutboundStreams?: number

                                                                                How many parallel outgoing streams to allow on the DHT protocol per connection

                                                                                Default

                                                                                64
                                                                                -

                                                                                Optional networkDialTimeout

                                                                                networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                Dynamic network timeout settings for sending messages to peers

                                                                                -

                                                                                Optional pingConcurrency

                                                                                pingConcurrency?: number

                                                                                How many peers to ping in parallel when deciding if they should +

                                                                                Optional networkDialTimeout

                                                                                networkDialTimeout?: Omit<AdaptiveTimeoutInit, "metricsName" | "metrics">

                                                                                Dynamic network timeout settings for sending messages to peers

                                                                                +

                                                                                Optional pingConcurrency

                                                                                pingConcurrency?: number

                                                                                How many peers to ping in parallel when deciding if they should be evicted from the routing table or not

                                                                                Default

                                                                                10
                                                                                -

                                                                                Optional pingTimeout

                                                                                pingTimeout?: number

                                                                                How long to wait in ms when pinging DHT peers to decide if they +

                                                                                Optional pingTimeout

                                                                                pingTimeout?: number

                                                                                How long to wait in ms when pinging DHT peers to decide if they should be evicted from the routing table or not.

                                                                                Default

                                                                                10000
                                                                                -

                                                                                Optional prefixLength

                                                                                prefixLength?: number

                                                                                How many bits of the KAD-ID of peers to use when creating the routing +

                                                                                Optional prefixLength

                                                                                prefixLength?: number

                                                                                How many bits of the KAD-ID of peers to use when creating the routing table.

                                                                                The routing table is a binary trie with peers stored in the leaf nodes. The larger this number gets, the taller the trie can grow and the more peers @@ -72,14 +72,14 @@ to locate a certain peer, but also that more memory is consumed.

                                                                                Default

                                                                                32
                                                                                -

                                                                                Optional protocol

                                                                                protocol?: string

                                                                                The network protocol to use

                                                                                +

                                                                                Optional protocol

                                                                                protocol?: string

                                                                                The network protocol to use

                                                                                Default

                                                                                "/ipfs/kad/1.0.0"
                                                                                -

                                                                                Optional providers

                                                                                providers?: ProvidersInit

                                                                                Initialization options for the Providers component

                                                                                -

                                                                                Optional querySelfInterval

                                                                                querySelfInterval?: number

                                                                                How often to query our own PeerId in order to ensure we have a +

                                                                                Optional providers

                                                                                providers?: ProvidersInit

                                                                                Initialization options for the Providers component

                                                                                +

                                                                                Optional querySelfInterval

                                                                                querySelfInterval?: number

                                                                                How often to query our own PeerId in order to ensure we have a good view on the KAD address space local to our PeerId

                                                                                -

                                                                                Optional selectors

                                                                                selectors?: Selectors

                                                                                Record selectors

                                                                                -

                                                                                Optional validators

                                                                                validators?: Validators

                                                                                Record validators

                                                                                -

                                                                                Methods

                                                                                Optional peerInfoMapper

                                                                                Optional selectors

                                                                                selectors?: Selectors

                                                                                Record selectors

                                                                                +

                                                                                Optional validators

                                                                                validators?: Validators

                                                                                Record validators

                                                                                +

                                                                                Methods

                                                                                Optional peerInfoMapper

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                allowQueryWithZeroPeersclientModeinitialQuerySelfIntervalkBucketSizekBucketSplitThresholdlogPrefixmaxInboundStreamsmaxOutboundStreamsnetworkDialTimeoutpingConcurrencypingTimeoutprefixLengthprotocolprovidersquerySelfIntervalselectorsvalidatorspeerInfoMapper
                                                                                \ No newline at end of file +

                                                                                Parameters

                                                                                Returns PeerInfo

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                allowQueryWithZeroPeersclientModeinitialQuerySelfIntervalkBucketSizekBucketSplitThresholdlogPrefixmaxInboundStreamsmaxOutboundStreamsnetworkDialTimeoutpingConcurrencypingTimeoutprefixLengthprotocolprovidersquerySelfIntervalselectorsvalidatorspeerInfoMapper
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.PeerInfoMapper.html b/interfaces/_libp2p_kad_dht.PeerInfoMapper.html index d6f8eda5ab..4aa06d578c 100644 --- a/interfaces/_libp2p_kad_dht.PeerInfoMapper.html +++ b/interfaces/_libp2p_kad_dht.PeerInfoMapper.html @@ -1 +1 @@ -PeerInfoMapper | libp2p

                                                                                Interface PeerInfoMapper

                                                                                interface PeerInfoMapper ((peer) => PeerInfo)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file +PeerInfoMapper | libp2p

                                                                                Interface PeerInfoMapper

                                                                                interface PeerInfoMapper ((peer) => PeerInfo)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.PeerResponseEvent.html b/interfaces/_libp2p_kad_dht.PeerResponseEvent.html index 0f5cc33ca0..86f99a834d 100644 --- a/interfaces/_libp2p_kad_dht.PeerResponseEvent.html +++ b/interfaces/_libp2p_kad_dht.PeerResponseEvent.html @@ -1,6 +1,6 @@ PeerResponseEvent | libp2p

                                                                                Interface PeerResponseEvent

                                                                                Emitted when query responses are received form remote peers. Depending on the query these events may be followed by a FinalPeerEvent, a ValueEvent or a ProviderEvent.

                                                                                -
                                                                                interface PeerResponseEvent {
                                                                                    closer: PeerInfo[];
                                                                                    from: PeerId;
                                                                                    messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                    messageType: MessageType;
                                                                                    name: "PEER_RESPONSE";
                                                                                    providers: PeerInfo[];
                                                                                    record?: DHTRecord;
                                                                                    type: PEER_RESPONSE;
                                                                                }

                                                                                Properties

                                                                                closer +
                                                                                interface PeerResponseEvent {
                                                                                    closer: PeerInfo[];
                                                                                    from: PeerId;
                                                                                    messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                    messageType: MessageType;
                                                                                    name: "PEER_RESPONSE";
                                                                                    providers: PeerInfo[];
                                                                                    record?: DHTRecord;
                                                                                    type: PEER_RESPONSE;
                                                                                }

                                                                                Properties

                                                                                closer from messageName messageType @@ -8,4 +8,4 @@ providers record? type -

                                                                                Properties

                                                                                closer

                                                                                closer: PeerInfo[]

                                                                                from

                                                                                from: PeerId

                                                                                messageName

                                                                                messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                messageType

                                                                                messageType: MessageType

                                                                                name

                                                                                name: "PEER_RESPONSE"

                                                                                providers

                                                                                providers: PeerInfo[]

                                                                                Optional record

                                                                                record?: DHTRecord

                                                                                type

                                                                                type: PEER_RESPONSE

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                closerfrommessageNamemessageTypenameprovidersrecordtype
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                closer

                                                                                closer: PeerInfo[]

                                                                                from

                                                                                from: PeerId

                                                                                messageName

                                                                                messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                messageType

                                                                                messageType: MessageType

                                                                                name

                                                                                name: "PEER_RESPONSE"

                                                                                providers

                                                                                providers: PeerInfo[]

                                                                                Optional record

                                                                                record?: DHTRecord

                                                                                type

                                                                                type: PEER_RESPONSE

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                closerfrommessageNamemessageTypenameprovidersrecordtype
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ProviderEvent.html b/interfaces/_libp2p_kad_dht.ProviderEvent.html index a24fededc8..62521542a4 100644 --- a/interfaces/_libp2p_kad_dht.ProviderEvent.html +++ b/interfaces/_libp2p_kad_dht.ProviderEvent.html @@ -1,6 +1,6 @@ ProviderEvent | libp2p

                                                                                Interface ProviderEvent

                                                                                Emitted when providers are found

                                                                                -
                                                                                interface ProviderEvent {
                                                                                    from: PeerId;
                                                                                    name: "PROVIDER";
                                                                                    providers: PeerInfo[];
                                                                                    type: PROVIDER;
                                                                                }

                                                                                Properties

                                                                                from +
                                                                                interface ProviderEvent {
                                                                                    from: PeerId;
                                                                                    name: "PROVIDER";
                                                                                    providers: PeerInfo[];
                                                                                    type: PROVIDER;
                                                                                }

                                                                                Properties

                                                                                from name providers type -

                                                                                Properties

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "PROVIDER"

                                                                                providers

                                                                                providers: PeerInfo[]

                                                                                type

                                                                                type: PROVIDER

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                fromnameproviderstype
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "PROVIDER"

                                                                                providers

                                                                                providers: PeerInfo[]

                                                                                type

                                                                                type: PROVIDER

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                fromnameproviderstype
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.QueryErrorEvent.html b/interfaces/_libp2p_kad_dht.QueryErrorEvent.html index 5986425c47..0c0d397637 100644 --- a/interfaces/_libp2p_kad_dht.QueryErrorEvent.html +++ b/interfaces/_libp2p_kad_dht.QueryErrorEvent.html @@ -1,6 +1,6 @@ QueryErrorEvent | libp2p

                                                                                Interface QueryErrorEvent

                                                                                Something went wrong with the query

                                                                                -
                                                                                interface QueryErrorEvent {
                                                                                    error: Error;
                                                                                    from: PeerId;
                                                                                    name: "QUERY_ERROR";
                                                                                    type: QUERY_ERROR;
                                                                                }

                                                                                Properties

                                                                                error +
                                                                                interface QueryErrorEvent {
                                                                                    error: Error;
                                                                                    from: PeerId;
                                                                                    name: "QUERY_ERROR";
                                                                                    type: QUERY_ERROR;
                                                                                }

                                                                                Properties

                                                                                error from name type -

                                                                                Properties

                                                                                error

                                                                                error: Error

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "QUERY_ERROR"

                                                                                type

                                                                                type: QUERY_ERROR

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                errorfromnametype
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                error

                                                                                error: Error

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "QUERY_ERROR"

                                                                                type

                                                                                type: QUERY_ERROR

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                errorfromnametype
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.RoutingTable.html b/interfaces/_libp2p_kad_dht.RoutingTable.html index c709981774..ef23ba8102 100644 --- a/interfaces/_libp2p_kad_dht.RoutingTable.html +++ b/interfaces/_libp2p_kad_dht.RoutingTable.html @@ -1,2 +1,2 @@ -RoutingTable | libp2p

                                                                                Interface RoutingTable

                                                                                interface RoutingTable {
                                                                                    size: number;
                                                                                }

                                                                                Properties

                                                                                size -

                                                                                Properties

                                                                                size

                                                                                size: number

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                size
                                                                                \ No newline at end of file +RoutingTable | libp2p

                                                                                Interface RoutingTable

                                                                                interface RoutingTable {
                                                                                    size: number;
                                                                                }

                                                                                Properties

                                                                                size +

                                                                                Properties

                                                                                size

                                                                                size: number

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                size
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SelectFn.html b/interfaces/_libp2p_kad_dht.SelectFn.html index d715cb228f..4860ae5add 100644 --- a/interfaces/_libp2p_kad_dht.SelectFn.html +++ b/interfaces/_libp2p_kad_dht.SelectFn.html @@ -1,3 +1,3 @@ SelectFn | libp2p

                                                                                Interface SelectFn

                                                                                A selector function takes a DHT key and a list of records and returns the index of the best record in the list

                                                                                -
                                                                                interface SelectFn ((key, records) => number)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file +
                                                                                interface SelectFn ((key, records) => number)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SendQueryEvent.html b/interfaces/_libp2p_kad_dht.SendQueryEvent.html index 3066faede5..87f38ea235 100644 --- a/interfaces/_libp2p_kad_dht.SendQueryEvent.html +++ b/interfaces/_libp2p_kad_dht.SendQueryEvent.html @@ -1,7 +1,7 @@ SendQueryEvent | libp2p

                                                                                Interface SendQueryEvent

                                                                                Emitted when sending queries to remote peers

                                                                                -
                                                                                interface SendQueryEvent {
                                                                                    messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                    messageType: MessageType;
                                                                                    name: "SEND_QUERY";
                                                                                    to: PeerId;
                                                                                    type: SEND_QUERY;
                                                                                }

                                                                                Properties

                                                                                messageName +
                                                                                interface SendQueryEvent {
                                                                                    messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec";
                                                                                    messageType: MessageType;
                                                                                    name: "SEND_QUERY";
                                                                                    to: PeerId;
                                                                                    type: SEND_QUERY;
                                                                                }

                                                                                Properties

                                                                                messageName messageType name to type -

                                                                                Properties

                                                                                messageName

                                                                                messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                messageType

                                                                                messageType: MessageType

                                                                                name

                                                                                name: "SEND_QUERY"

                                                                                to

                                                                                to: PeerId

                                                                                type

                                                                                type: SEND_QUERY

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                messageNamemessageTypenametotype
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                messageName

                                                                                messageName: "PUT_VALUE" | "GET_VALUE" | "ADD_PROVIDER" | "GET_PROVIDERS" | "FIND_NODE" | "PING" | "codec"

                                                                                messageType

                                                                                messageType: MessageType

                                                                                name

                                                                                name: "SEND_QUERY"

                                                                                to

                                                                                to: PeerId

                                                                                type

                                                                                type: SEND_QUERY

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                messageNamemessageTypenametotype
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.SingleKadDHT.html b/interfaces/_libp2p_kad_dht.SingleKadDHT.html index 29d19afa3c..a28a5385fd 100644 --- a/interfaces/_libp2p_kad_dht.SingleKadDHT.html +++ b/interfaces/_libp2p_kad_dht.SingleKadDHT.html @@ -1,4 +1,4 @@ -SingleKadDHT | libp2p

                                                                                Interface SingleKadDHT

                                                                                interface SingleKadDHT {
                                                                                    routingTable: RoutingTable;
                                                                                    findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                                    findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                                    get(key, options?): AsyncIterable<QueryEvent>;
                                                                                    getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                                    getMode(): "client" | "server";
                                                                                    provide(key, options?): AsyncIterable<QueryEvent>;
                                                                                    put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                                    refreshRoutingTable(): Promise<void>;
                                                                                    setMode(mode): Promise<void>;
                                                                                }

                                                                                Hierarchy (view full)

                                                                                Properties

                                                                                routingTable +SingleKadDHT | libp2p

                                                                                Interface SingleKadDHT

                                                                                interface SingleKadDHT {
                                                                                    routingTable: RoutingTable;
                                                                                    findPeer(id, options?): AsyncIterable<QueryEvent>;
                                                                                    findProviders(key, options?): AsyncIterable<QueryEvent>;
                                                                                    get(key, options?): AsyncIterable<QueryEvent>;
                                                                                    getClosestPeers(key, options?): AsyncIterable<QueryEvent>;
                                                                                    getMode(): "client" | "server";
                                                                                    provide(key, options?): AsyncIterable<QueryEvent>;
                                                                                    put(key, value, options?): AsyncIterable<QueryEvent>;
                                                                                    refreshRoutingTable(): Promise<void>;
                                                                                    setMode(mode): Promise<void>;
                                                                                }

                                                                                Hierarchy (view full)

                                                                                Properties

                                                                                routingTable

                                                                                Methods

                                                                                findPeer findProviders get @@ -8,14 +8,14 @@ put refreshRoutingTable setMode -

                                                                                Properties

                                                                                routingTable

                                                                                routingTable: RoutingTable

                                                                                Methods

                                                                                findPeer

                                                                                findProviders

                                                                                get

                                                                                getClosestPeers

                                                                                getMode

                                                                                provide

                                                                                put

                                                                                refreshRoutingTable

                                                                                setMode

                                                                                • setMode(mode): Promise<void>

                                                                                • If 'server' this node will respond to DHT queries, if 'client' this node +

                                                                                Properties

                                                                                routingTable

                                                                                routingTable: RoutingTable

                                                                                Methods

                                                                                findPeer

                                                                                findProviders

                                                                                get

                                                                                getClosestPeers

                                                                                getMode

                                                                                provide

                                                                                put

                                                                                refreshRoutingTable

                                                                                setMode

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                routingTablefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                                                \ No newline at end of file +

                                                                                Parameters

                                                                                • mode: "client" | "server"

                                                                                Returns Promise<void>

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                routingTablefindPeerfindProvidersgetgetClosestPeersgetModeprovideputrefreshRoutingTablesetMode
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ValidateFn.html b/interfaces/_libp2p_kad_dht.ValidateFn.html index e929643eaa..874144e396 100644 --- a/interfaces/_libp2p_kad_dht.ValidateFn.html +++ b/interfaces/_libp2p_kad_dht.ValidateFn.html @@ -1,3 +1,3 @@ ValidateFn | libp2p

                                                                                Interface ValidateFn

                                                                                A validator function takes a DHT key and the value of the record for that key and throws if the record is invalid

                                                                                -
                                                                                interface ValidateFn ((key, value) => Promise<void>)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file +
                                                                                interface ValidateFn ((key, value) => Promise<void>)

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_kad_dht.ValueEvent.html b/interfaces/_libp2p_kad_dht.ValueEvent.html index e5c3dbeafc..a273f96952 100644 --- a/interfaces/_libp2p_kad_dht.ValueEvent.html +++ b/interfaces/_libp2p_kad_dht.ValueEvent.html @@ -1,6 +1,6 @@ ValueEvent | libp2p

                                                                                Interface ValueEvent

                                                                                Emitted when values are found

                                                                                -
                                                                                interface ValueEvent {
                                                                                    from: PeerId;
                                                                                    name: "VALUE";
                                                                                    type: VALUE;
                                                                                    value: Uint8Array;
                                                                                }

                                                                                Properties

                                                                                from +
                                                                                interface ValueEvent {
                                                                                    from: PeerId;
                                                                                    name: "VALUE";
                                                                                    type: VALUE;
                                                                                    value: Uint8Array;
                                                                                }

                                                                                Properties

                                                                                from name type value -

                                                                                Properties

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "VALUE"

                                                                                type

                                                                                type: VALUE

                                                                                value

                                                                                value: Uint8Array

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                fromnametypevalue
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                from

                                                                                from: PeerId

                                                                                name

                                                                                name: "VALUE"

                                                                                type

                                                                                type: VALUE

                                                                                value

                                                                                value: Uint8Array

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                fromnametypevalue
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.DEKConfig.html b/interfaces/_libp2p_keychain.DEKConfig.html index 5234e50ac4..7657de2dba 100644 --- a/interfaces/_libp2p_keychain.DEKConfig.html +++ b/interfaces/_libp2p_keychain.DEKConfig.html @@ -1,5 +1,5 @@ -DEKConfig | libp2p

                                                                                Interface DEKConfig

                                                                                interface DEKConfig {
                                                                                    hash: string;
                                                                                    iterationCount: number;
                                                                                    keyLength: number;
                                                                                    salt: string;
                                                                                }

                                                                                Properties

                                                                                hash +DEKConfig | libp2p

                                                                                Interface DEKConfig

                                                                                interface DEKConfig {
                                                                                    hash: string;
                                                                                    iterationCount: number;
                                                                                    keyLength: number;
                                                                                    salt: string;
                                                                                }

                                                                                Properties

                                                                                hash iterationCount keyLength salt -

                                                                                Properties

                                                                                hash

                                                                                hash: string

                                                                                iterationCount

                                                                                iterationCount: number

                                                                                keyLength

                                                                                keyLength: number

                                                                                salt

                                                                                salt: string

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                hashiterationCountkeyLengthsalt
                                                                                \ No newline at end of file +

                                                                                Properties

                                                                                hash

                                                                                hash: string

                                                                                iterationCount

                                                                                iterationCount: number

                                                                                keyLength

                                                                                keyLength: number

                                                                                salt

                                                                                salt: string

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                hashiterationCountkeyLengthsalt
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeyInfo.html b/interfaces/_libp2p_keychain.KeyInfo.html index cb3b3c0e39..fcfe7513ab 100644 --- a/interfaces/_libp2p_keychain.KeyInfo.html +++ b/interfaces/_libp2p_keychain.KeyInfo.html @@ -1,5 +1,5 @@ -KeyInfo | libp2p

                                                                                Interface KeyInfo

                                                                                interface KeyInfo {
                                                                                    id: string;
                                                                                    name: string;
                                                                                }

                                                                                Properties

                                                                                id +KeyInfo | libp2p

                                                                                Interface KeyInfo

                                                                                interface KeyInfo {
                                                                                    id: string;
                                                                                    name: string;
                                                                                }

                                                                                Properties

                                                                                id name

                                                                                Properties

                                                                                id

                                                                                id: string

                                                                                The universally unique key id

                                                                                -

                                                                                name

                                                                                name: string

                                                                                The local key name

                                                                                -

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                idname
                                                                                \ No newline at end of file +

                                                                                name

                                                                                name: string

                                                                                The local key name

                                                                                +

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                idname
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.Keychain.html b/interfaces/_libp2p_keychain.Keychain.html index dc3e9520d8..c3de7679a2 100644 --- a/interfaces/_libp2p_keychain.Keychain.html +++ b/interfaces/_libp2p_keychain.Keychain.html @@ -1,4 +1,4 @@ -Keychain | libp2p

                                                                                Interface Keychain

                                                                                interface Keychain {
                                                                                    createKey(name, type, size?): Promise<KeyInfo>;
                                                                                    exportKey(name, password): Promise<Multibase<"m">>;
                                                                                    exportPeerId(name): Promise<PeerId>;
                                                                                    findKeyById(id): Promise<KeyInfo>;
                                                                                    findKeyByName(name): Promise<KeyInfo>;
                                                                                    importKey(name, pem, password): Promise<KeyInfo>;
                                                                                    importPeer(name, peerId): Promise<KeyInfo>;
                                                                                    listKeys(): Promise<KeyInfo[]>;
                                                                                    removeKey(name): Promise<KeyInfo>;
                                                                                    renameKey(oldName, newName): Promise<KeyInfo>;
                                                                                    rotateKeychainPass(oldPass, newPass): Promise<void>;
                                                                                }

                                                                                Methods

                                                                                createKey +Keychain | libp2p

                                                                                Interface Keychain

                                                                                interface Keychain {
                                                                                    createKey(name, type, size?): Promise<KeyInfo>;
                                                                                    exportKey(name, password): Promise<Multibase<"m">>;
                                                                                    exportPeerId(name): Promise<PeerId>;
                                                                                    findKeyById(id): Promise<KeyInfo>;
                                                                                    findKeyByName(name): Promise<KeyInfo>;
                                                                                    importKey(name, pem, password): Promise<KeyInfo>;
                                                                                    importPeer(name, peerId): Promise<KeyInfo>;
                                                                                    listKeys(): Promise<KeyInfo[]>;
                                                                                    removeKey(name): Promise<KeyInfo>;
                                                                                    renameKey(oldName, newName): Promise<KeyInfo>;
                                                                                    rotateKeychainPass(oldPass, newPass): Promise<void>;
                                                                                }

                                                                                Methods

                                                                                createKey exportKey exportPeerId findKeyById @@ -12,34 +12,34 @@

                                                                                Methods

                                                                                createKey

                                                                                • createKey(name, type, size?): Promise<KeyInfo>

                                                                                • Create a key in the keychain.

                                                                                  Parameters

                                                                                  • name: string
                                                                                  • type: KeyTypes
                                                                                  • Optional size: number

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  -

                                                                                exportKey

                                                                                exportKey

                                                                                • exportKey(name, password): Promise<Multibase<"m">>

                                                                                • Export an existing key as a PEM encrypted PKCS #8 string.

                                                                                  Parameters

                                                                                  • name: string
                                                                                  • password: string

                                                                                  Returns Promise<Multibase<"m">>

                                                                                  Example

                                                                                  await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const pemKey = await libp2p.keychain.exportKey('keyTest', 'password123')
                                                                                  -

                                                                                exportPeerId

                                                                                exportPeerId

                                                                                • exportPeerId(name): Promise<PeerId>

                                                                                • Export an existing key as a PeerId

                                                                                  Parameters

                                                                                  • name: string

                                                                                  Returns Promise<PeerId>

                                                                                  Example

                                                                                  const peerId = await libp2p.keychain.exportPeerId('key-name')
                                                                                  -

                                                                                findKeyById

                                                                                findKeyById

                                                                                • findKeyById(id): Promise<KeyInfo>

                                                                                • Find a key by it's id.

                                                                                  Parameters

                                                                                  • id: string

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const keyInfo2 = await libp2p.keychain.findKeyById(keyInfo.id)
                                                                                  -

                                                                                findKeyByName

                                                                                findKeyByName

                                                                                • findKeyByName(name): Promise<KeyInfo>

                                                                                • Find a key by it's name.

                                                                                  Parameters

                                                                                  • name: string

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  const keyInfo = await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const keyInfo2 = await libp2p.keychain.findKeyByName('keyTest')
                                                                                  -

                                                                                importKey

                                                                                importKey

                                                                                • importKey(name, pem, password): Promise<KeyInfo>

                                                                                • Import a new key from a PEM encoded PKCS #8 string.

                                                                                  Parameters

                                                                                  • name: string
                                                                                  • pem: string
                                                                                  • password: string

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const pemKey = await libp2p.keychain.exportKey('keyTest', 'password123')
                                                                                  const keyInfo = await libp2p.keychain.importKey('keyTestImport', pemKey, 'password123')
                                                                                  -

                                                                                importPeer

                                                                                importPeer

                                                                                • importPeer(name, peerId): Promise<KeyInfo>

                                                                                • Import a new key from a PeerId with a private key component

                                                                                  Parameters

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  const keyInfo = await libp2p.keychain.importPeer('keyTestImport', peerIdFromString('12D3Foo...'))
                                                                                  -

                                                                                listKeys

                                                                                listKeys

                                                                                removeKey

                                                                                removeKey

                                                                                • removeKey(name): Promise<KeyInfo>

                                                                                • Removes a key from the keychain.

                                                                                  Parameters

                                                                                  • name: string

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const keyInfo = await libp2p.keychain.removeKey('keyTest')
                                                                                  -

                                                                                renameKey

                                                                                renameKey

                                                                                • renameKey(oldName, newName): Promise<KeyInfo>

                                                                                • Rename a key in the keychain.

                                                                                  Parameters

                                                                                  • oldName: string
                                                                                  • newName: string

                                                                                  Returns Promise<KeyInfo>

                                                                                  Example

                                                                                  await libp2p.keychain.createKey('keyTest', 'RSA', 4096)
                                                                                  const keyInfo = await libp2p.keychain.renameKey('keyTest', 'keyNewNtest')
                                                                                  -

                                                                                rotateKeychainPass

                                                                                • rotateKeychainPass(oldPass, newPass): Promise<void>

                                                                                • Rotate keychain password and re-encrypt all associated keys

                                                                                  +

                                                                                rotateKeychainPass

                                                                                • rotateKeychainPass(oldPass, newPass): Promise<void>

                                                                                • Rotate keychain password and re-encrypt all associated keys

                                                                                  Parameters

                                                                                  • oldPass: string
                                                                                  • newPass: string

                                                                                  Returns Promise<void>

                                                                                  Example

                                                                                  await libp2p.keychain.rotateKeychainPass('oldPassword', 'newPassword')
                                                                                  -

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                createKeyexportKeyexportPeerIdfindKeyByIdfindKeyByNameimportKeyimportPeerlistKeysremoveKeyrenameKeyrotateKeychainPass
                                                                                \ No newline at end of file +

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                On This Page

                                                                                createKeyexportKeyexportPeerIdfindKeyByIdfindKeyByNameimportKeyimportPeerlistKeysremoveKeyrenameKeyrotateKeychainPass
                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeychainComponents.html b/interfaces/_libp2p_keychain.KeychainComponents.html index d276abcfdb..ec2003f2e1 100644 --- a/interfaces/_libp2p_keychain.KeychainComponents.html +++ b/interfaces/_libp2p_keychain.KeychainComponents.html @@ -1,3 +1,3 @@ -KeychainComponents | libp2p

                                                                                Interface KeychainComponents

                                                                                interface KeychainComponents {
                                                                                    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                    logger: ComponentLogger;
                                                                                }

                                                                                Properties

                                                                                datastore +KeychainComponents | libp2p

                                                                                Interface KeychainComponents

                                                                                interface KeychainComponents {
                                                                                    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                    logger: ComponentLogger;
                                                                                }

                                                                                Properties

                                                                                datastore logger -

                                                                                Properties

                                                                                datastore

                                                                                datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    logger

                                                                                                    logger: ComponentLogger

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    Theme

                                                                                                    On This Page

                                                                                                    datastorelogger
                                                                                                    \ No newline at end of file +

                                                                                                    Properties

                                                                                                    datastore

                                                                                                    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  Type declaration

                                                                                                                    Type declaration

                                                                                                                      Type declaration

                                                                                                                        logger

                                                                                                                        logger: ComponentLogger

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        datastorelogger
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_keychain.KeychainInit.html b/interfaces/_libp2p_keychain.KeychainInit.html index 77cdd4137c..9847050a6f 100644 --- a/interfaces/_libp2p_keychain.KeychainInit.html +++ b/interfaces/_libp2p_keychain.KeychainInit.html @@ -1,3 +1,3 @@ -KeychainInit | libp2p

                                                                                                                        Interface KeychainInit

                                                                                                                        interface KeychainInit {
                                                                                                                            dek?: DEKConfig;
                                                                                                                            pass?: string;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        dek? +KeychainInit | libp2p

                                                                                                                        Interface KeychainInit

                                                                                                                        interface KeychainInit {
                                                                                                                            dek?: DEKConfig;
                                                                                                                            pass?: string;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        dek? pass? -

                                                                                                                        Properties

                                                                                                                        Optional dek

                                                                                                                        dek?: DEKConfig

                                                                                                                        Optional pass

                                                                                                                        pass?: string

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        dekpass
                                                                                                                        \ No newline at end of file +

                                                                                                                        Properties

                                                                                                                        Optional dek

                                                                                                                        dek?: DEKConfig

                                                                                                                        Optional pass

                                                                                                                        pass?: string

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        dekpass
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_logger.ComponentLogger.html b/interfaces/_libp2p_logger.ComponentLogger.html index e0973d7cb8..6b6be8d4cb 100644 --- a/interfaces/_libp2p_logger.ComponentLogger.html +++ b/interfaces/_libp2p_logger.ComponentLogger.html @@ -1,2 +1,2 @@ -ComponentLogger | libp2p

                                                                                                                        Interface ComponentLogger

                                                                                                                        interface ComponentLogger {
                                                                                                                            forComponent(name): Logger;
                                                                                                                        }

                                                                                                                        Methods

                                                                                                                        forComponent -

                                                                                                                        Methods

                                                                                                                        forComponent

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        forComponent
                                                                                                                        \ No newline at end of file +ComponentLogger | libp2p

                                                                                                                        Interface ComponentLogger

                                                                                                                        interface ComponentLogger {
                                                                                                                            forComponent(name): Logger;
                                                                                                                        }

                                                                                                                        Methods

                                                                                                                        forComponent +

                                                                                                                        Methods

                                                                                                                        forComponent

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        forComponent
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_logger.Logger.html b/interfaces/_libp2p_logger.Logger.html index 38d7f60d6c..208b441720 100644 --- a/interfaces/_libp2p_logger.Logger.html +++ b/interfaces/_libp2p_logger.Logger.html @@ -1,4 +1,4 @@ -Logger | libp2p

                                                                                                                        Interface Logger

                                                                                                                        interface Logger {
                                                                                                                            enabled: boolean;
                                                                                                                            error(formatter, ...args): void;
                                                                                                                            trace(formatter, ...args): void;
                                                                                                                            (formatter, ...args): void;
                                                                                                                        }
                                                                                                                        • Logger(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        Properties

                                                                                                                        enabled +Logger | libp2p

                                                                                                                        Interface Logger

                                                                                                                        interface Logger {
                                                                                                                            enabled: boolean;
                                                                                                                            error(formatter, ...args): void;
                                                                                                                            trace(formatter, ...args): void;
                                                                                                                            (formatter, ...args): void;
                                                                                                                        }
                                                                                                                        • Logger(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        Properties

                                                                                                                        enabled

                                                                                                                        Methods

                                                                                                                        error trace -

                                                                                                                        Properties

                                                                                                                        enabled

                                                                                                                        enabled: boolean

                                                                                                                        Methods

                                                                                                                        error

                                                                                                                        • error(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        trace

                                                                                                                        • trace(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        enablederrortrace
                                                                                                                        \ No newline at end of file +

                                                                                                                        Properties

                                                                                                                        enabled

                                                                                                                        enabled: boolean

                                                                                                                        Methods

                                                                                                                        error

                                                                                                                        • error(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        trace

                                                                                                                        • trace(formatter, ...args): void

                                                                                                                        • Parameters

                                                                                                                          • formatter: any
                                                                                                                          • Rest ...args: any[]

                                                                                                                          Returns void

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        enablederrortrace
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_logger.PeerLoggerOptions.html b/interfaces/_libp2p_logger.PeerLoggerOptions.html index 17a9d0ebc3..9e338fb0df 100644 --- a/interfaces/_libp2p_logger.PeerLoggerOptions.html +++ b/interfaces/_libp2p_logger.PeerLoggerOptions.html @@ -1,3 +1,3 @@ -PeerLoggerOptions | libp2p

                                                                                                                        Interface PeerLoggerOptions

                                                                                                                        interface PeerLoggerOptions {
                                                                                                                            prefixLength: number;
                                                                                                                            suffixLength: number;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        prefixLength +PeerLoggerOptions | libp2p

                                                                                                                        Interface PeerLoggerOptions

                                                                                                                        interface PeerLoggerOptions {
                                                                                                                            prefixLength: number;
                                                                                                                            suffixLength: number;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        prefixLength suffixLength -

                                                                                                                        Properties

                                                                                                                        prefixLength

                                                                                                                        prefixLength: number

                                                                                                                        suffixLength

                                                                                                                        suffixLength: number

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        prefixLengthsuffixLength
                                                                                                                        \ No newline at end of file +

                                                                                                                        Properties

                                                                                                                        prefixLength

                                                                                                                        prefixLength: number

                                                                                                                        suffixLength

                                                                                                                        suffixLength: number

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        prefixLengthsuffixLength
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_mplex.MplexInit.html b/interfaces/_libp2p_mplex.MplexInit.html index bd1310eb04..0e8e42f2a2 100644 --- a/interfaces/_libp2p_mplex.MplexInit.html +++ b/interfaces/_libp2p_mplex.MplexInit.html @@ -1,4 +1,4 @@ -MplexInit | libp2p

                                                                                                                        Interface MplexInit

                                                                                                                        interface MplexInit {
                                                                                                                            disconnectThreshold?: number;
                                                                                                                            maxInboundStreams?: number;
                                                                                                                            maxMsgSize?: number;
                                                                                                                            maxOutboundStreams?: number;
                                                                                                                            maxStreamBufferSize?: number;
                                                                                                                            maxUnprocessedMessageQueueSize?: number;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        disconnectThreshold? +MplexInit | libp2p

                                                                                                                        Interface MplexInit

                                                                                                                        interface MplexInit {
                                                                                                                            disconnectThreshold?: number;
                                                                                                                            maxInboundStreams?: number;
                                                                                                                            maxMsgSize?: number;
                                                                                                                            maxOutboundStreams?: number;
                                                                                                                            maxStreamBufferSize?: number;
                                                                                                                            maxUnprocessedMessageQueueSize?: number;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        disconnectThreshold? maxInboundStreams? maxMsgSize? maxOutboundStreams? @@ -7,22 +7,22 @@

                                                                                                                        Properties

                                                                                                                        Optional disconnectThreshold

                                                                                                                        disconnectThreshold?: number

                                                                                                                        When maxInboundStreams is hit, if the remote continues try to open more than this many new multiplexed streams per second the connection will be closed (default: 5)

                                                                                                                        -

                                                                                                                        Optional maxInboundStreams

                                                                                                                        maxInboundStreams?: number

                                                                                                                        The maximum number of multiplexed streams that can be open at any +

                                                                                                                        Optional maxInboundStreams

                                                                                                                        maxInboundStreams?: number

                                                                                                                        The maximum number of multiplexed streams that can be open at any one time. A request to open more than this will have a stream reset message sent immediately as a response for the newly opened stream id (default: 1024)

                                                                                                                        -

                                                                                                                        Optional maxMsgSize

                                                                                                                        maxMsgSize?: number

                                                                                                                        The maximum size of message that can be sent in one go in bytes. +

                                                                                                                        Optional maxMsgSize

                                                                                                                        maxMsgSize?: number

                                                                                                                        The maximum size of message that can be sent in one go in bytes. Messages larger than this will be split into multiple smaller messages. If we receive a message larger than this an error will be thrown and the connection closed. (default: 1MB)

                                                                                                                        -

                                                                                                                        Optional maxOutboundStreams

                                                                                                                        maxOutboundStreams?: number

                                                                                                                        The maximum number of multiplexed streams that can be open at any +

                                                                                                                        Optional maxOutboundStreams

                                                                                                                        maxOutboundStreams?: number

                                                                                                                        The maximum number of multiplexed streams that can be open at any one time. An attempt to open more than this will throw (default: 1024)

                                                                                                                        -

                                                                                                                        Optional maxStreamBufferSize

                                                                                                                        maxStreamBufferSize?: number

                                                                                                                        Incoming stream messages are buffered until processed by the stream +

                                                                                                                        Optional maxStreamBufferSize

                                                                                                                        maxStreamBufferSize?: number

                                                                                                                        Incoming stream messages are buffered until processed by the stream handler. If the buffer reaches this size in bytes the stream will be reset (default: 4MB)

                                                                                                                        -

                                                                                                                        Optional maxUnprocessedMessageQueueSize

                                                                                                                        maxUnprocessedMessageQueueSize?: number

                                                                                                                        Constrains the size of the unprocessed message queue buffer. +

                                                                                                                        Optional maxUnprocessedMessageQueueSize

                                                                                                                        maxUnprocessedMessageQueueSize?: number

                                                                                                                        Constrains the size of the unprocessed message queue buffer. Before messages are deserialized, the raw bytes are buffered to ensure we have the complete message to deserialized. If the queue gets longer than this value an error will be thrown and the connection closed. (default: 4MB)

                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        disconnectThresholdmaxInboundStreamsmaxMsgSizemaxOutboundStreamsmaxStreamBufferSizemaxUnprocessedMessageQueueSize
                                                                                                                        \ No newline at end of file +

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        disconnectThresholdmaxInboundStreamsmaxMsgSizemaxOutboundStreamsmaxStreamBufferSizemaxUnprocessedMessageQueueSize
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html b/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html index 78d6315e80..e447ecb814 100644 --- a/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html +++ b/interfaces/_libp2p_multistream_select.MultistreamSelectInit.html @@ -2,7 +2,7 @@ the optional signal property.

                                                                                                                        Example

                                                                                                                        const controller = new AbortController()

                                                                                                                        aLongRunningOperation({
                                                                                                                          signal: controller.signal
                                                                                                                        })

                                                                                                                        // later

                                                                                                                        controller.abort()
                                                                                                                        -
                                                                                                                        interface MultistreamSelectInit {
                                                                                                                            log: Logger;
                                                                                                                            maxDataLength?: number;
                                                                                                                            maxLengthLength?: number;
                                                                                                                            negotiateFully?: boolean;
                                                                                                                            signal?: AbortSignal;
                                                                                                                            yieldBytes?: boolean;
                                                                                                                            lengthDecoder?(data): number;
                                                                                                                            lengthEncoder?(value): Uint8Array | Uint8ArrayList;
                                                                                                                        }

                                                                                                                        Hierarchy (view full)

                                                                                                                        Properties

                                                                                                                        log +
                                                                                                                        interface MultistreamSelectInit {
                                                                                                                            log: Logger;
                                                                                                                            maxDataLength?: number;
                                                                                                                            maxLengthLength?: number;
                                                                                                                            negotiateFully?: boolean;
                                                                                                                            signal?: AbortSignal;
                                                                                                                            yieldBytes?: boolean;
                                                                                                                            lengthDecoder?(data): number;
                                                                                                                            lengthEncoder?(value): Uint8Array | Uint8ArrayList;
                                                                                                                        }

                                                                                                                        Hierarchy (view full)

                                                                                                                        Properties

                                                                                                                        log maxDataLength? maxLengthLength? negotiateFully? @@ -15,7 +15,7 @@ initial message, saving a round trip for connection establishment.

                                                                                                                        Default

                                                                                                                        true
                                                                                                                        -

                                                                                                                        Optional signal

                                                                                                                        signal?: AbortSignal

                                                                                                                        Optional yieldBytes

                                                                                                                        yieldBytes?: boolean

                                                                                                                        After the stream is unwrapped, any bytes that have been read from the +

                                                                                                                        Optional signal

                                                                                                                        signal?: AbortSignal

                                                                                                                        Optional yieldBytes

                                                                                                                        yieldBytes?: boolean

                                                                                                                        After the stream is unwrapped, any bytes that have been read from the incoming stream will be yielded in-order as Uint8Array(s).

                                                                                                                        To yield a single Uint8ArrayList with all unread bytes instead, pass false here.

                                                                                                                        diff --git a/interfaces/_libp2p_multistream_select.ProtocolStream.html b/interfaces/_libp2p_multistream_select.ProtocolStream.html index be4cf9ea9c..66848b86f5 100644 --- a/interfaces/_libp2p_multistream_select.ProtocolStream.html +++ b/interfaces/_libp2p_multistream_select.ProtocolStream.html @@ -1,3 +1,3 @@ -ProtocolStream | libp2p

                                                                                                                        Interface ProtocolStream<Stream>

                                                                                                                        interface ProtocolStream<Stream> {
                                                                                                                            protocol: string;
                                                                                                                            stream: Stream;
                                                                                                                        }

                                                                                                                        Type Parameters

                                                                                                                        • Stream

                                                                                                                        Properties

                                                                                                                        protocol +ProtocolStream | libp2p

                                                                                                                        Interface ProtocolStream<Stream>

                                                                                                                        interface ProtocolStream<Stream> {
                                                                                                                            protocol: string;
                                                                                                                            stream: Stream;
                                                                                                                        }

                                                                                                                        Type Parameters

                                                                                                                        • Stream

                                                                                                                        Properties

                                                                                                                        protocol stream -

                                                                                                                        Properties

                                                                                                                        protocol

                                                                                                                        protocol: string

                                                                                                                        stream

                                                                                                                        stream: Stream

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        protocolstream
                                                                                                                        \ No newline at end of file +

                                                                                                                        Properties

                                                                                                                        protocol

                                                                                                                        protocol: string

                                                                                                                        stream

                                                                                                                        stream: Stream

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        protocolstream
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_peer_record.PeerRecordInit.html b/interfaces/_libp2p_peer_record.PeerRecordInit.html index 158d8010e0..be78253093 100644 --- a/interfaces/_libp2p_peer_record.PeerRecordInit.html +++ b/interfaces/_libp2p_peer_record.PeerRecordInit.html @@ -1,6 +1,6 @@ -PeerRecordInit | libp2p

                                                                                                                        Interface PeerRecordInit

                                                                                                                        interface PeerRecordInit {
                                                                                                                            multiaddrs?: Multiaddr[];
                                                                                                                            peerId: PeerId;
                                                                                                                            seqNumber?: bigint;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        multiaddrs? +PeerRecordInit | libp2p

                                                                                                                        Interface PeerRecordInit

                                                                                                                        interface PeerRecordInit {
                                                                                                                            multiaddrs?: Multiaddr[];
                                                                                                                            peerId: PeerId;
                                                                                                                            seqNumber?: bigint;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        multiaddrs? peerId seqNumber?

                                                                                                                        Properties

                                                                                                                        Optional multiaddrs

                                                                                                                        multiaddrs?: Multiaddr[]

                                                                                                                        Addresses of the associated peer.

                                                                                                                        -

                                                                                                                        peerId

                                                                                                                        peerId: PeerId

                                                                                                                        Optional seqNumber

                                                                                                                        seqNumber?: bigint

                                                                                                                        Monotonically-increasing sequence counter that's used to order PeerRecords in time.

                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        multiaddrspeerIdseqNumber
                                                                                                                        \ No newline at end of file +

                                                                                                                        peerId

                                                                                                                        peerId: PeerId

                                                                                                                        Optional seqNumber

                                                                                                                        seqNumber?: bigint

                                                                                                                        Monotonically-increasing sequence counter that's used to order PeerRecords in time.

                                                                                                                        +

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        multiaddrspeerIdseqNumber
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html b/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html index 46d033764b..9b37176665 100644 --- a/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html +++ b/interfaces/_libp2p_peer_record.RecordEnvelopeInit.html @@ -1,5 +1,5 @@ -RecordEnvelopeInit | libp2p

                                                                                                                        Interface RecordEnvelopeInit

                                                                                                                        interface RecordEnvelopeInit {
                                                                                                                            payload: Uint8Array;
                                                                                                                            payloadType: Uint8Array;
                                                                                                                            peerId: PeerId;
                                                                                                                            signature: Uint8Array;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        payload +RecordEnvelopeInit | libp2p

                                                                                                                        Interface RecordEnvelopeInit

                                                                                                                        interface RecordEnvelopeInit {
                                                                                                                            payload: Uint8Array;
                                                                                                                            payloadType: Uint8Array;
                                                                                                                            peerId: PeerId;
                                                                                                                            signature: Uint8Array;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        payload payloadType peerId signature -

                                                                                                                        Properties

                                                                                                                        payload

                                                                                                                        payload: Uint8Array

                                                                                                                        payloadType

                                                                                                                        payloadType: Uint8Array

                                                                                                                        peerId

                                                                                                                        peerId: PeerId

                                                                                                                        signature

                                                                                                                        signature: Uint8Array

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        payloadpayloadTypepeerIdsignature
                                                                                                                        \ No newline at end of file +

                                                                                                                        Properties

                                                                                                                        payload

                                                                                                                        payload: Uint8Array

                                                                                                                        payloadType

                                                                                                                        payloadType: Uint8Array

                                                                                                                        peerId

                                                                                                                        peerId: PeerId

                                                                                                                        signature

                                                                                                                        signature: Uint8Array

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        On This Page

                                                                                                                        payloadpayloadTypepeerIdsignature
                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.AddressFilter.html b/interfaces/_libp2p_peer_store.AddressFilter.html index df8e143c25..f0eb181d01 100644 --- a/interfaces/_libp2p_peer_store.AddressFilter.html +++ b/interfaces/_libp2p_peer_store.AddressFilter.html @@ -1,2 +1,2 @@ AddressFilter | libp2p

                                                                                                                        Interface AddressFilter

                                                                                                                        Return true to allow storing the passed multiaddr for the passed peer

                                                                                                                        -
                                                                                                                        interface AddressFilter ((peerId, multiaddr) => boolean | Promise<boolean>)

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        \ No newline at end of file +
                                                                                                                        interface AddressFilter ((peerId, multiaddr) => boolean | Promise<boolean>)

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html b/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html index 209daf251f..a03b0e2023 100644 --- a/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html +++ b/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html @@ -1,5 +1,5 @@ -PersistentPeerStoreComponents | libp2p

                                                                                                                        Interface PersistentPeerStoreComponents

                                                                                                                        interface PersistentPeerStoreComponents {
                                                                                                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                            logger: ComponentLogger;
                                                                                                                            peerId: PeerId;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        datastore +PersistentPeerStoreComponents | libp2p

                                                                                                                        Interface PersistentPeerStoreComponents

                                                                                                                        interface PersistentPeerStoreComponents {
                                                                                                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>;
                                                                                                                            logger: ComponentLogger;
                                                                                                                            peerId: PeerId;
                                                                                                                        }

                                                                                                                        Properties

                                                                                                                        datastore events logger peerId -

                                                                                                                        Properties

                                                                                                                        datastore

                                                                                                                        datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                        Type declaration

                                                                                                                          Type declaration

                                                                                                                            Type declaration

                                                                                                                              Type declaration

                                                                                                                                Type declaration

                                                                                                                                  Type declaration

                                                                                                                                    Type declaration

                                                                                                                                      Type declaration

                                                                                                                                        Type declaration

                                                                                                                                          Type declaration

                                                                                                                                            events

                                                                                                                                            events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                            logger

                                                                                                                                            logger: ComponentLogger

                                                                                                                                            peerId

                                                                                                                                            peerId: PeerId

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            Theme

                                                                                                                                            On This Page

                                                                                                                                            datastoreeventsloggerpeerId
                                                                                                                                            \ No newline at end of file +

                                                                                                                                            Properties

                                                                                                                                            datastore

                                                                                                                                            datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                            Type declaration

                                                                                                                                              Type declaration

                                                                                                                                                Type declaration

                                                                                                                                                  Type declaration

                                                                                                                                                    Type declaration

                                                                                                                                                      Type declaration

                                                                                                                                                        Type declaration

                                                                                                                                                          Type declaration

                                                                                                                                                            Type declaration

                                                                                                                                                              Type declaration

                                                                                                                                                                events

                                                                                                                                                                events: TypedEventTarget<Libp2pEvents<ServiceMap>>

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                peerId

                                                                                                                                                                peerId: PeerId

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                datastoreeventsloggerpeerId
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html b/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html index 8a850da887..e4d736ea5c 100644 --- a/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html +++ b/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html @@ -1,2 +1,2 @@ -PersistentPeerStoreInit | libp2p

                                                                                                                                                                Interface PersistentPeerStoreInit

                                                                                                                                                                interface PersistentPeerStoreInit {
                                                                                                                                                                    addressFilter?: AddressFilter;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                addressFilter? -

                                                                                                                                                                Properties

                                                                                                                                                                Optional addressFilter

                                                                                                                                                                addressFilter?: AddressFilter

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                addressFilter
                                                                                                                                                                \ No newline at end of file +PersistentPeerStoreInit | libp2p

                                                                                                                                                                Interface PersistentPeerStoreInit

                                                                                                                                                                interface PersistentPeerStoreInit {
                                                                                                                                                                    addressFilter?: AddressFilter;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                addressFilter? +

                                                                                                                                                                Properties

                                                                                                                                                                Optional addressFilter

                                                                                                                                                                addressFilter?: AddressFilter

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                addressFilter
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_perf.Perf.html b/interfaces/_libp2p_perf.Perf.html index 5ac869c94e..3315863eb5 100644 --- a/interfaces/_libp2p_perf.Perf.html +++ b/interfaces/_libp2p_perf.Perf.html @@ -1,2 +1,2 @@ -Perf | libp2p

                                                                                                                                                                Interface Perf

                                                                                                                                                                interface Perf {
                                                                                                                                                                    measurePerformance(multiaddr, sendBytes, recvBytes, options?): AsyncGenerator<PerfOutput, any, unknown>;
                                                                                                                                                                }

                                                                                                                                                                Methods

                                                                                                                                                                measurePerformance -

                                                                                                                                                                Methods

                                                                                                                                                                measurePerformance

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                measurePerformance
                                                                                                                                                                \ No newline at end of file +Perf | libp2p

                                                                                                                                                                Interface Perf

                                                                                                                                                                interface Perf {
                                                                                                                                                                    measurePerformance(multiaddr, sendBytes, recvBytes, options?): AsyncGenerator<PerfOutput, any, unknown>;
                                                                                                                                                                }

                                                                                                                                                                Methods

                                                                                                                                                                measurePerformance +

                                                                                                                                                                Methods

                                                                                                                                                                measurePerformance

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                measurePerformance
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfComponents.html b/interfaces/_libp2p_perf.PerfComponents.html index 91f9ba3253..8e31719f1a 100644 --- a/interfaces/_libp2p_perf.PerfComponents.html +++ b/interfaces/_libp2p_perf.PerfComponents.html @@ -1,4 +1,4 @@ -PerfComponents | libp2p

                                                                                                                                                                Interface PerfComponents

                                                                                                                                                                interface PerfComponents {
                                                                                                                                                                    connectionManager: ConnectionManager;
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                    registrar: Registrar;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager +PerfComponents | libp2p

                                                                                                                                                                Interface PerfComponents

                                                                                                                                                                interface PerfComponents {
                                                                                                                                                                    connectionManager: ConnectionManager;
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                    registrar: Registrar;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager logger registrar -

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager

                                                                                                                                                                connectionManager: ConnectionManager

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                registrar

                                                                                                                                                                registrar: Registrar

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                connectionManagerloggerregistrar
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager

                                                                                                                                                                connectionManager: ConnectionManager

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                registrar

                                                                                                                                                                registrar: Registrar

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                connectionManagerloggerregistrar
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfInit.html b/interfaces/_libp2p_perf.PerfInit.html index adffaf1a7a..1e34c5c74d 100644 --- a/interfaces/_libp2p_perf.PerfInit.html +++ b/interfaces/_libp2p_perf.PerfInit.html @@ -1,7 +1,7 @@ -PerfInit | libp2p

                                                                                                                                                                Interface PerfInit

                                                                                                                                                                interface PerfInit {
                                                                                                                                                                    maxInboundStreams?: number;
                                                                                                                                                                    maxOutboundStreams?: number;
                                                                                                                                                                    protocolName?: string;
                                                                                                                                                                    runOnTransientConnection?: boolean;
                                                                                                                                                                    writeBlockSize?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                maxInboundStreams? +PerfInit | libp2p

                                                                                                                                                                Interface PerfInit

                                                                                                                                                                interface PerfInit {
                                                                                                                                                                    maxInboundStreams?: number;
                                                                                                                                                                    maxOutboundStreams?: number;
                                                                                                                                                                    protocolName?: string;
                                                                                                                                                                    runOnTransientConnection?: boolean;
                                                                                                                                                                    writeBlockSize?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                maxInboundStreams? maxOutboundStreams? protocolName? runOnTransientConnection? writeBlockSize? -

                                                                                                                                                                Properties

                                                                                                                                                                Optional maxInboundStreams

                                                                                                                                                                maxInboundStreams?: number

                                                                                                                                                                Optional maxOutboundStreams

                                                                                                                                                                maxOutboundStreams?: number

                                                                                                                                                                Optional protocolName

                                                                                                                                                                protocolName?: string

                                                                                                                                                                Optional runOnTransientConnection

                                                                                                                                                                runOnTransientConnection?: boolean

                                                                                                                                                                Optional writeBlockSize

                                                                                                                                                                writeBlockSize?: number

                                                                                                                                                                Data sent/received will be sent in chunks of this size (default: 64KiB)

                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                maxInboundStreamsmaxOutboundStreamsprotocolNamerunOnTransientConnectionwriteBlockSize
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Properties

                                                                                                                                                                Optional maxInboundStreams

                                                                                                                                                                maxInboundStreams?: number

                                                                                                                                                                Optional maxOutboundStreams

                                                                                                                                                                maxOutboundStreams?: number

                                                                                                                                                                Optional protocolName

                                                                                                                                                                protocolName?: string

                                                                                                                                                                Optional runOnTransientConnection

                                                                                                                                                                runOnTransientConnection?: boolean

                                                                                                                                                                Optional writeBlockSize

                                                                                                                                                                writeBlockSize?: number

                                                                                                                                                                Data sent/received will be sent in chunks of this size (default: 64KiB)

                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                maxInboundStreamsmaxOutboundStreamsprotocolNamerunOnTransientConnectionwriteBlockSize
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfOptions.html b/interfaces/_libp2p_perf.PerfOptions.html index 2873937fde..e776e59e85 100644 --- a/interfaces/_libp2p_perf.PerfOptions.html +++ b/interfaces/_libp2p_perf.PerfOptions.html @@ -2,10 +2,10 @@ the optional signal property.

                                                                                                                                                                Example

                                                                                                                                                                const controller = new AbortController()

                                                                                                                                                                aLongRunningOperation({
                                                                                                                                                                  signal: controller.signal
                                                                                                                                                                })

                                                                                                                                                                // later

                                                                                                                                                                controller.abort()
                                                                                                                                                                -
                                                                                                                                                                interface PerfOptions {
                                                                                                                                                                    reuseExistingConnection?: boolean;
                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                }

                                                                                                                                                                Hierarchy (view full)

                                                                                                                                                                Properties

                                                                                                                                                                reuseExistingConnection? +
                                                                                                                                                                interface PerfOptions {
                                                                                                                                                                    reuseExistingConnection?: boolean;
                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                }

                                                                                                                                                                Hierarchy (view full)

                                                                                                                                                                Properties

                                                                                                                                                                reuseExistingConnection? signal?

                                                                                                                                                                Properties

                                                                                                                                                                Optional reuseExistingConnection

                                                                                                                                                                reuseExistingConnection?: boolean

                                                                                                                                                                By default measuring perf should include the time it takes to establish a connection, so a new connection will be opened for every performance run.

                                                                                                                                                                To override this and re-use an existing connection if one is present, pass true here. (default: false)

                                                                                                                                                                -

                                                                                                                                                                Optional signal

                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                reuseExistingConnectionsignal
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Optional signal

                                                                                                                                                                signal?: AbortSignal

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                reuseExistingConnectionsignal
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_perf.PerfOutput.html b/interfaces/_libp2p_perf.PerfOutput.html index 1174b79b35..e40a266fd1 100644 --- a/interfaces/_libp2p_perf.PerfOutput.html +++ b/interfaces/_libp2p_perf.PerfOutput.html @@ -1,5 +1,5 @@ -PerfOutput | libp2p

                                                                                                                                                                Interface PerfOutput

                                                                                                                                                                interface PerfOutput {
                                                                                                                                                                    downloadBytes: number;
                                                                                                                                                                    timeSeconds: number;
                                                                                                                                                                    type: "stream" | "intermediary" | "connection" | "final";
                                                                                                                                                                    uploadBytes: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                downloadBytes +PerfOutput | libp2p

                                                                                                                                                                Interface PerfOutput

                                                                                                                                                                interface PerfOutput {
                                                                                                                                                                    downloadBytes: number;
                                                                                                                                                                    timeSeconds: number;
                                                                                                                                                                    type: "stream" | "intermediary" | "connection" | "final";
                                                                                                                                                                    uploadBytes: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                downloadBytes timeSeconds type uploadBytes -

                                                                                                                                                                Properties

                                                                                                                                                                downloadBytes

                                                                                                                                                                downloadBytes: number

                                                                                                                                                                timeSeconds

                                                                                                                                                                timeSeconds: number

                                                                                                                                                                type

                                                                                                                                                                type: "stream" | "intermediary" | "connection" | "final"

                                                                                                                                                                uploadBytes

                                                                                                                                                                uploadBytes: number

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                downloadBytestimeSecondstypeuploadBytes
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Properties

                                                                                                                                                                downloadBytes

                                                                                                                                                                downloadBytes: number

                                                                                                                                                                timeSeconds

                                                                                                                                                                timeSeconds: number

                                                                                                                                                                type

                                                                                                                                                                type: "stream" | "intermediary" | "connection" | "final"

                                                                                                                                                                uploadBytes

                                                                                                                                                                uploadBytes: number

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                downloadBytestimeSecondstypeuploadBytes
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingService.html b/interfaces/_libp2p_ping.PingService.html index d4973c551c..9a2775337f 100644 --- a/interfaces/_libp2p_ping.PingService.html +++ b/interfaces/_libp2p_ping.PingService.html @@ -1,2 +1,2 @@ -PingService | libp2p

                                                                                                                                                                Interface PingService

                                                                                                                                                                interface PingService {
                                                                                                                                                                    ping(peer, options?): Promise<number>;
                                                                                                                                                                }

                                                                                                                                                                Methods

                                                                                                                                                                ping -

                                                                                                                                                                Methods

                                                                                                                                                                ping

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                ping
                                                                                                                                                                \ No newline at end of file +PingService | libp2p

                                                                                                                                                                Interface PingService

                                                                                                                                                                interface PingService {
                                                                                                                                                                    ping(peer, options?): Promise<number>;
                                                                                                                                                                }

                                                                                                                                                                Methods

                                                                                                                                                                ping +

                                                                                                                                                                Methods

                                                                                                                                                                ping

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                ping
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingServiceComponents.html b/interfaces/_libp2p_ping.PingServiceComponents.html index 80524f6be4..b8f90b0b78 100644 --- a/interfaces/_libp2p_ping.PingServiceComponents.html +++ b/interfaces/_libp2p_ping.PingServiceComponents.html @@ -1,4 +1,4 @@ -PingServiceComponents | libp2p

                                                                                                                                                                Interface PingServiceComponents

                                                                                                                                                                interface PingServiceComponents {
                                                                                                                                                                    connectionManager: ConnectionManager;
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                    registrar: Registrar;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager +PingServiceComponents | libp2p

                                                                                                                                                                Interface PingServiceComponents

                                                                                                                                                                interface PingServiceComponents {
                                                                                                                                                                    connectionManager: ConnectionManager;
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                    registrar: Registrar;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager logger registrar -

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager

                                                                                                                                                                connectionManager: ConnectionManager

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                registrar

                                                                                                                                                                registrar: Registrar

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                connectionManagerloggerregistrar
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Properties

                                                                                                                                                                connectionManager

                                                                                                                                                                connectionManager: ConnectionManager

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                registrar

                                                                                                                                                                registrar: Registrar

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                connectionManagerloggerregistrar
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_ping.PingServiceInit.html b/interfaces/_libp2p_ping.PingServiceInit.html index 707672652c..88805a2302 100644 --- a/interfaces/_libp2p_ping.PingServiceInit.html +++ b/interfaces/_libp2p_ping.PingServiceInit.html @@ -1,7 +1,7 @@ -PingServiceInit | libp2p

                                                                                                                                                                Interface PingServiceInit

                                                                                                                                                                interface PingServiceInit {
                                                                                                                                                                    maxInboundStreams?: number;
                                                                                                                                                                    maxOutboundStreams?: number;
                                                                                                                                                                    protocolPrefix?: string;
                                                                                                                                                                    runOnTransientConnection?: boolean;
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                maxInboundStreams? +PingServiceInit | libp2p

                                                                                                                                                                Interface PingServiceInit

                                                                                                                                                                interface PingServiceInit {
                                                                                                                                                                    maxInboundStreams?: number;
                                                                                                                                                                    maxOutboundStreams?: number;
                                                                                                                                                                    protocolPrefix?: string;
                                                                                                                                                                    runOnTransientConnection?: boolean;
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                maxInboundStreams? maxOutboundStreams? protocolPrefix? runOnTransientConnection? timeout? -

                                                                                                                                                                Properties

                                                                                                                                                                Optional maxInboundStreams

                                                                                                                                                                maxInboundStreams?: number

                                                                                                                                                                Optional maxOutboundStreams

                                                                                                                                                                maxOutboundStreams?: number

                                                                                                                                                                Optional protocolPrefix

                                                                                                                                                                protocolPrefix?: string

                                                                                                                                                                Optional runOnTransientConnection

                                                                                                                                                                runOnTransientConnection?: boolean

                                                                                                                                                                Optional timeout

                                                                                                                                                                timeout?: number

                                                                                                                                                                How long we should wait for a ping response

                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnTransientConnectiontimeout
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Properties

                                                                                                                                                                Optional maxInboundStreams

                                                                                                                                                                maxInboundStreams?: number

                                                                                                                                                                Optional maxOutboundStreams

                                                                                                                                                                maxOutboundStreams?: number

                                                                                                                                                                Optional protocolPrefix

                                                                                                                                                                protocolPrefix?: string

                                                                                                                                                                Optional runOnTransientConnection

                                                                                                                                                                runOnTransientConnection?: boolean

                                                                                                                                                                Optional timeout

                                                                                                                                                                timeout?: number

                                                                                                                                                                How long we should wait for a ping response

                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                maxInboundStreamsmaxOutboundStreamsprotocolPrefixrunOnTransientConnectiontimeout
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_plaintext.PlaintextComponents.html b/interfaces/_libp2p_plaintext.PlaintextComponents.html index 12eec6e874..bf6e7df81d 100644 --- a/interfaces/_libp2p_plaintext.PlaintextComponents.html +++ b/interfaces/_libp2p_plaintext.PlaintextComponents.html @@ -1,2 +1,2 @@ -PlaintextComponents | libp2p

                                                                                                                                                                Interface PlaintextComponents

                                                                                                                                                                interface PlaintextComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger -

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file +PlaintextComponents | libp2p

                                                                                                                                                                Interface PlaintextComponents

                                                                                                                                                                interface PlaintextComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger +

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_plaintext.PlaintextInit.html b/interfaces/_libp2p_plaintext.PlaintextInit.html index 0691501e6b..6a6003a81a 100644 --- a/interfaces/_libp2p_plaintext.PlaintextInit.html +++ b/interfaces/_libp2p_plaintext.PlaintextInit.html @@ -1,4 +1,4 @@ -PlaintextInit | libp2p

                                                                                                                                                                Interface PlaintextInit

                                                                                                                                                                interface PlaintextInit {
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                timeout? +PlaintextInit | libp2p

                                                                                                                                                                Interface PlaintextInit

                                                                                                                                                                interface PlaintextInit {
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                timeout?

                                                                                                                                                                Properties

                                                                                                                                                                Optional timeout

                                                                                                                                                                timeout?: number

                                                                                                                                                                The peer id exchange must complete within this many milliseconds (default: 1000)

                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                timeout
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                timeout
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_pnet.ProtectorComponents.html b/interfaces/_libp2p_pnet.ProtectorComponents.html index b0b413f496..44dc379614 100644 --- a/interfaces/_libp2p_pnet.ProtectorComponents.html +++ b/interfaces/_libp2p_pnet.ProtectorComponents.html @@ -1,2 +1,2 @@ -ProtectorComponents | libp2p

                                                                                                                                                                Interface ProtectorComponents

                                                                                                                                                                interface ProtectorComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger -

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file +ProtectorComponents | libp2p

                                                                                                                                                                Interface ProtectorComponents

                                                                                                                                                                interface ProtectorComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger +

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_pnet.ProtectorInit.html b/interfaces/_libp2p_pnet.ProtectorInit.html index 2cbc2630c9..1342974213 100644 --- a/interfaces/_libp2p_pnet.ProtectorInit.html +++ b/interfaces/_libp2p_pnet.ProtectorInit.html @@ -1,7 +1,7 @@ -ProtectorInit | libp2p

                                                                                                                                                                Interface ProtectorInit

                                                                                                                                                                interface ProtectorInit {
                                                                                                                                                                    psk: Uint8Array;
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                psk +ProtectorInit | libp2p

                                                                                                                                                                Interface ProtectorInit

                                                                                                                                                                interface ProtectorInit {
                                                                                                                                                                    psk: Uint8Array;
                                                                                                                                                                    timeout?: number;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                psk timeout?

                                                                                                                                                                Properties

                                                                                                                                                                psk

                                                                                                                                                                psk: Uint8Array

                                                                                                                                                                A pre-shared key. This must be the same byte value for all peers in the swarm in order for them to communicate.

                                                                                                                                                                -

                                                                                                                                                                Optional timeout

                                                                                                                                                                timeout?: number

                                                                                                                                                                The initial nonce exchange must complete within this many milliseconds +

                                                                                                                                                                Optional timeout

                                                                                                                                                                timeout?: number

                                                                                                                                                                The initial nonce exchange must complete within this many milliseconds (default: 1000)

                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                psktimeout
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                psktimeout
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html index 04fab2ef39..a19495f8f6 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusCalculatedMetricOptions.html @@ -1,6 +1,6 @@ PrometheusCalculatedMetricOptions | libp2p

                                                                                                                                                                Interface PrometheusCalculatedMetricOptions<T>

                                                                                                                                                                Create tracked metrics that are expensive to calculate by passing a function that is only invoked when metrics are being scraped

                                                                                                                                                                -
                                                                                                                                                                interface PrometheusCalculatedMetricOptions<T> {
                                                                                                                                                                    calculate: CalculateMetric<T>;
                                                                                                                                                                    help?: string;
                                                                                                                                                                    label?: string;
                                                                                                                                                                    registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                }

                                                                                                                                                                Type Parameters

                                                                                                                                                                • T = number

                                                                                                                                                                Hierarchy (view full)

                                                                                                                                                                Properties

                                                                                                                                                                calculate +
                                                                                                                                                                interface PrometheusCalculatedMetricOptions<T> {
                                                                                                                                                                    calculate: CalculateMetric<T>;
                                                                                                                                                                    help?: string;
                                                                                                                                                                    label?: string;
                                                                                                                                                                    registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                }

                                                                                                                                                                Type Parameters

                                                                                                                                                                • T = number

                                                                                                                                                                Hierarchy (view full)

                                                                                                                                                                Properties

                                                                                                                                                                calculate help? label? registry? @@ -8,4 +8,4 @@ using .update, .increment, and .decrement

                                                                                                                                                                Optional help

                                                                                                                                                                help?: string

                                                                                                                                                                Optional help for the metric

                                                                                                                                                                Optional label

                                                                                                                                                                label?: string

                                                                                                                                                                Optional label for the metric

                                                                                                                                                                -

                                                                                                                                                                Optional registry

                                                                                                                                                                registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                calculatehelplabelregistry
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Optional registry

                                                                                                                                                                registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                calculatehelplabelregistry
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html index 077d0b4fd9..265a5858c6 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsComponents.html @@ -1,2 +1,2 @@ -PrometheusMetricsComponents | libp2p

                                                                                                                                                                Interface PrometheusMetricsComponents

                                                                                                                                                                interface PrometheusMetricsComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger -

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file +PrometheusMetricsComponents | libp2p

                                                                                                                                                                Interface PrometheusMetricsComponents

                                                                                                                                                                interface PrometheusMetricsComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                logger +

                                                                                                                                                                Properties

                                                                                                                                                                logger

                                                                                                                                                                logger: ComponentLogger

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                logger
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html index ead7f08844..c035acf901 100644 --- a/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html +++ b/interfaces/_libp2p_prometheus_metrics.PrometheusMetricsInit.html @@ -1,13 +1,13 @@ -PrometheusMetricsInit | libp2p

                                                                                                                                                                Interface PrometheusMetricsInit

                                                                                                                                                                interface PrometheusMetricsInit {
                                                                                                                                                                    collectDefaultMetrics?: boolean;
                                                                                                                                                                    defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>;
                                                                                                                                                                    preserveExistingMetrics?: boolean;
                                                                                                                                                                    registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                collectDefaultMetrics? +PrometheusMetricsInit | libp2p

                                                                                                                                                                Interface PrometheusMetricsInit

                                                                                                                                                                interface PrometheusMetricsInit {
                                                                                                                                                                    collectDefaultMetrics?: boolean;
                                                                                                                                                                    defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>;
                                                                                                                                                                    preserveExistingMetrics?: boolean;
                                                                                                                                                                    registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">;
                                                                                                                                                                }

                                                                                                                                                                Properties

                                                                                                                                                                collectDefaultMetrics? defaultMetrics? preserveExistingMetrics? registry?

                                                                                                                                                                Properties

                                                                                                                                                                Optional collectDefaultMetrics

                                                                                                                                                                collectDefaultMetrics?: boolean

                                                                                                                                                                By default we collect default metrics - CPU, memory etc, to not do this, pass true here

                                                                                                                                                                -

                                                                                                                                                                Optional defaultMetrics

                                                                                                                                                                defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>

                                                                                                                                                                prom-client options to pass to the collectDefaultMetrics function

                                                                                                                                                                -

                                                                                                                                                                Optional preserveExistingMetrics

                                                                                                                                                                preserveExistingMetrics?: boolean

                                                                                                                                                                All metrics in prometheus are global so to prevent clashes in naming +

                                                                                                                                                                Optional defaultMetrics

                                                                                                                                                                defaultMetrics?: DefaultMetricsCollectorConfiguration<RegistryContentType>

                                                                                                                                                                prom-client options to pass to the collectDefaultMetrics function

                                                                                                                                                                +

                                                                                                                                                                Optional preserveExistingMetrics

                                                                                                                                                                preserveExistingMetrics?: boolean

                                                                                                                                                                All metrics in prometheus are global so to prevent clashes in naming we reset the global metrics registry on creation - to not do this, pass true here

                                                                                                                                                                -

                                                                                                                                                                Optional registry

                                                                                                                                                                registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                Use a custom registry to register metrics. +

                                                                                                                                                                Optional registry

                                                                                                                                                                registry?: Registry<"text/plain; version=0.0.4; charset=utf-8">

                                                                                                                                                                Use a custom registry to register metrics. By default, the global registry is used to register metrics.

                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                collectDefaultMetricsdefaultMetricspreserveExistingMetricsregistry
                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                On This Page

                                                                                                                                                                collectDefaultMetricsdefaultMetricspreserveExistingMetricsregistry
                                                                                                                                                                \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.index.PubSubComponents.html b/interfaces/_libp2p_pubsub.index.PubSubComponents.html index 636085044d..a82c546d9c 100644 --- a/interfaces/_libp2p_pubsub.index.PubSubComponents.html +++ b/interfaces/_libp2p_pubsub.index.PubSubComponents.html @@ -1,4 +1,4 @@ -PubSubComponents | libp2p

                                                                                                                                                                Interface PubSubComponents

                                                                                                                                                                interface PubSubComponents {
                                                                                                                                                                    logger: ComponentLogger;
                                                                                                                                                                    peerId: PeerId;
                                                                                                                                                                    registrar: Registrar;
                                                                                                                                                                }

                                                                                                                                                                Hierarchy

                                                                                                                                                                • PubSubComponents

                                                                                                                                                                  Properties

                                                                                                                                                                  logger +PubSubComponents | libp2p

                                                                                                                                                                  Interface PubSubComponents

                                                                                                                                                                  interface PubSubComponents {
                                                                                                                                                                      logger: ComponentLogger;
                                                                                                                                                                      peerId: PeerId;
                                                                                                                                                                      registrar: Registrar;
                                                                                                                                                                  }

                                                                                                                                                                  Hierarchy

                                                                                                                                                                  • PubSubComponents

                                                                                                                                                                    Properties

                                                                                                                                                                    logger peerId registrar -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    registrar

                                                                                                                                                                    registrar: Registrar

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggerpeerIdregistrar
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    registrar

                                                                                                                                                                    registrar: Registrar

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggerpeerIdregistrar
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html index be78bb8c02..334797f0d9 100644 --- a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html +++ b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsComponents.html @@ -1,2 +1,2 @@ -PeerStreamsComponents | libp2p

                                                                                                                                                                    Interface PeerStreamsComponents

                                                                                                                                                                    interface PeerStreamsComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    logger
                                                                                                                                                                    \ No newline at end of file +PeerStreamsComponents | libp2p

                                                                                                                                                                    Interface PeerStreamsComponents

                                                                                                                                                                    interface PeerStreamsComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    logger
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html index 23dd5d62eb..29423869c3 100644 --- a/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html +++ b/interfaces/_libp2p_pubsub.peer_streams.PeerStreamsInit.html @@ -1,3 +1,3 @@ -PeerStreamsInit | libp2p

                                                                                                                                                                    Interface PeerStreamsInit

                                                                                                                                                                    interface PeerStreamsInit {
                                                                                                                                                                        id: PeerId;
                                                                                                                                                                        protocol: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    id +PeerStreamsInit | libp2p

                                                                                                                                                                    Interface PeerStreamsInit

                                                                                                                                                                    interface PeerStreamsInit {
                                                                                                                                                                        id: PeerId;
                                                                                                                                                                        protocol: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    id protocol -

                                                                                                                                                                    Properties

                                                                                                                                                                    id

                                                                                                                                                                    id: PeerId

                                                                                                                                                                    protocol

                                                                                                                                                                    protocol: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    idprotocol
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    id

                                                                                                                                                                    id: PeerId

                                                                                                                                                                    protocol

                                                                                                                                                                    protocol: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    idprotocol
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_simple_metrics.OnMetrics.html b/interfaces/_libp2p_simple_metrics.OnMetrics.html index e3ee98383c..a73267e1d0 100644 --- a/interfaces/_libp2p_simple_metrics.OnMetrics.html +++ b/interfaces/_libp2p_simple_metrics.OnMetrics.html @@ -1 +1 @@ -OnMetrics | libp2p

                                                                                                                                                                    Interface OnMetrics

                                                                                                                                                                    interface OnMetrics ((metrics) => void)
                                                                                                                                                                    • OnMetrics(metrics): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      Returns void

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file +OnMetrics | libp2p

                                                                                                                                                                    Interface OnMetrics

                                                                                                                                                                    interface OnMetrics ((metrics) => void)
                                                                                                                                                                    • OnMetrics(metrics): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      Returns void

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html b/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html index 0e136f468f..08d064087d 100644 --- a/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html +++ b/interfaces/_libp2p_simple_metrics.SimpleMetricsInit.html @@ -1,5 +1,5 @@ -SimpleMetricsInit | libp2p

                                                                                                                                                                    Interface SimpleMetricsInit

                                                                                                                                                                    interface SimpleMetricsInit {
                                                                                                                                                                        intervalMs?: number;
                                                                                                                                                                        onMetrics: OnMetrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    intervalMs? +SimpleMetricsInit | libp2p

                                                                                                                                                                    Interface SimpleMetricsInit

                                                                                                                                                                    interface SimpleMetricsInit {
                                                                                                                                                                        intervalMs?: number;
                                                                                                                                                                        onMetrics: OnMetrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    intervalMs? onMetrics

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional intervalMs

                                                                                                                                                                    intervalMs?: number

                                                                                                                                                                    How often to invoke the onMetrics callback

                                                                                                                                                                    -

                                                                                                                                                                    onMetrics

                                                                                                                                                                    onMetrics: OnMetrics

                                                                                                                                                                    A callback periodically invoked with collected metrics

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    intervalMsonMetrics
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    onMetrics

                                                                                                                                                                    onMetrics: OnMetrics

                                                                                                                                                                    A callback periodically invoked with collected metrics

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    intervalMsonMetrics
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPComponents.html b/interfaces/_libp2p_tcp.TCPComponents.html index b734d27b1b..a943447c16 100644 --- a/interfaces/_libp2p_tcp.TCPComponents.html +++ b/interfaces/_libp2p_tcp.TCPComponents.html @@ -1,3 +1,3 @@ -TCPComponents | libp2p

                                                                                                                                                                    Interface TCPComponents

                                                                                                                                                                    interface TCPComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger +TCPComponents | libp2p

                                                                                                                                                                    Interface TCPComponents

                                                                                                                                                                    interface TCPComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger metrics? -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetrics
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetrics
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html b/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html index d0c6aa3676..85099f7e40 100644 --- a/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html +++ b/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html @@ -1,5 +1,5 @@ TCPCreateListenerOptions | libp2p

                                                                                                                                                                    Interface TCPCreateListenerOptions

                                                                                                                                                                    Expose a subset of net.connect options

                                                                                                                                                                    -
                                                                                                                                                                    interface TCPCreateListenerOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        handler?: ConnectionHandler;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        upgrader: Upgrader;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? +
                                                                                                                                                                    interface TCPCreateListenerOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        handler?: ConnectionHandler;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        upgrader: Upgrader;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? handler? keepAlive? keepAliveInitialDelay? @@ -7,7 +7,7 @@ signal? upgrader

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional allowHalfOpen

                                                                                                                                                                    allowHalfOpen?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                    -

                                                                                                                                                                    Optional handler

                                                                                                                                                                    handler?: ConnectionHandler

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    upgrader

                                                                                                                                                                    upgrader: Upgrader

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenhandlerkeepAlivekeepAliveInitialDelaynoDelaysignalupgrader
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional handler

                                                                                                                                                                    handler?: ConnectionHandler

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    upgrader

                                                                                                                                                                    upgrader: Upgrader

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenhandlerkeepAlivekeepAliveInitialDelaynoDelaysignalupgrader
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPDialOptions.html b/interfaces/_libp2p_tcp.TCPDialOptions.html index 574ca81637..0fa220f961 100644 --- a/interfaces/_libp2p_tcp.TCPDialOptions.html +++ b/interfaces/_libp2p_tcp.TCPDialOptions.html @@ -1,5 +1,5 @@ TCPDialOptions | libp2p

                                                                                                                                                                    Interface TCPDialOptions

                                                                                                                                                                    Expose a subset of net.connect options

                                                                                                                                                                    -
                                                                                                                                                                    interface TCPDialOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        onProgress?: ((evt) => void);
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        upgrader: Upgrader;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? +
                                                                                                                                                                    interface TCPDialOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        onProgress?: ((evt) => void);
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        upgrader: Upgrader;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? @@ -7,7 +7,7 @@ signal? upgrader

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional allowHalfOpen

                                                                                                                                                                    allowHalfOpen?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional onProgress

                                                                                                                                                                    onProgress?: ((evt) => void)

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    upgrader

                                                                                                                                                                    upgrader: Upgrader

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelayonProgresssignalupgrader
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional onProgress

                                                                                                                                                                    onProgress?: ((evt) => void)

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    upgrader

                                                                                                                                                                    upgrader: Upgrader

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelayonProgresssignalupgrader
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPMetrics.html b/interfaces/_libp2p_tcp.TCPMetrics.html index 0030c237e6..6955daddd8 100644 --- a/interfaces/_libp2p_tcp.TCPMetrics.html +++ b/interfaces/_libp2p_tcp.TCPMetrics.html @@ -1,2 +1,2 @@ -TCPMetrics | libp2p

                                                                                                                                                                    Interface TCPMetrics

                                                                                                                                                                    interface TCPMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents -

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file +TCPMetrics | libp2p

                                                                                                                                                                    Interface TCPMetrics

                                                                                                                                                                    interface TCPMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents +

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPOptions.html b/interfaces/_libp2p_tcp.TCPOptions.html index 65f25ef79a..cd90b77623 100644 --- a/interfaces/_libp2p_tcp.TCPOptions.html +++ b/interfaces/_libp2p_tcp.TCPOptions.html @@ -1,4 +1,4 @@ -TCPOptions | libp2p

                                                                                                                                                                    Interface TCPOptions

                                                                                                                                                                    interface TCPOptions {
                                                                                                                                                                        backlog?: number;
                                                                                                                                                                        closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts;
                                                                                                                                                                        dialOpts?: TCPSocketOptions;
                                                                                                                                                                        inboundSocketInactivityTimeout?: number;
                                                                                                                                                                        listenOpts?: TCPSocketOptions;
                                                                                                                                                                        maxConnections?: number;
                                                                                                                                                                        outboundSocketInactivityTimeout?: number;
                                                                                                                                                                        socketCloseTimeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    backlog? +TCPOptions | libp2p

                                                                                                                                                                    Interface TCPOptions

                                                                                                                                                                    interface TCPOptions {
                                                                                                                                                                        backlog?: number;
                                                                                                                                                                        closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts;
                                                                                                                                                                        dialOpts?: TCPSocketOptions;
                                                                                                                                                                        inboundSocketInactivityTimeout?: number;
                                                                                                                                                                        listenOpts?: TCPSocketOptions;
                                                                                                                                                                        maxConnections?: number;
                                                                                                                                                                        outboundSocketInactivityTimeout?: number;
                                                                                                                                                                        socketCloseTimeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    backlog? closeServerOnMaxConnections? dialOpts? inboundSocketInactivityTimeout? @@ -8,13 +8,13 @@ socketCloseTimeout?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional backlog

                                                                                                                                                                    backlog?: number

                                                                                                                                                                    Parameter to specify the maximum length of the queue of pending connections https://nodejs.org/dist/latest-v18.x/docs/api/net.html#serverlisten

                                                                                                                                                                    -

                                                                                                                                                                    Optional closeServerOnMaxConnections

                                                                                                                                                                    closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts

                                                                                                                                                                    Close server (stop listening for new connections) if connections exceed a limit. +

                                                                                                                                                                    Optional closeServerOnMaxConnections

                                                                                                                                                                    closeServerOnMaxConnections?: CloseServerOnMaxConnectionsOpts

                                                                                                                                                                    Close server (stop listening for new connections) if connections exceed a limit. Open server (start listening for new connections) if connections fall below a limit.

                                                                                                                                                                    -

                                                                                                                                                                    Optional dialOpts

                                                                                                                                                                    dialOpts?: TCPSocketOptions

                                                                                                                                                                    Options passed to net.connect for every opened TCP socket

                                                                                                                                                                    -

                                                                                                                                                                    Optional inboundSocketInactivityTimeout

                                                                                                                                                                    inboundSocketInactivityTimeout?: number

                                                                                                                                                                    An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                    -

                                                                                                                                                                    Optional listenOpts

                                                                                                                                                                    listenOpts?: TCPSocketOptions

                                                                                                                                                                    Options passed to every net.createServer for every TCP server

                                                                                                                                                                    -

                                                                                                                                                                    Optional maxConnections

                                                                                                                                                                    maxConnections?: number

                                                                                                                                                                    Set this property to reject connections when the server's connection count gets high. +

                                                                                                                                                                    Optional dialOpts

                                                                                                                                                                    dialOpts?: TCPSocketOptions

                                                                                                                                                                    Options passed to net.connect for every opened TCP socket

                                                                                                                                                                    +

                                                                                                                                                                    Optional inboundSocketInactivityTimeout

                                                                                                                                                                    inboundSocketInactivityTimeout?: number

                                                                                                                                                                    An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                    +

                                                                                                                                                                    Optional listenOpts

                                                                                                                                                                    listenOpts?: TCPSocketOptions

                                                                                                                                                                    Options passed to every net.createServer for every TCP server

                                                                                                                                                                    +

                                                                                                                                                                    Optional maxConnections

                                                                                                                                                                    maxConnections?: number

                                                                                                                                                                    Set this property to reject connections when the server's connection count gets high. https://nodejs.org/api/net.html#servermaxconnections

                                                                                                                                                                    -

                                                                                                                                                                    Optional outboundSocketInactivityTimeout

                                                                                                                                                                    outboundSocketInactivityTimeout?: number

                                                                                                                                                                    An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                    -

                                                                                                                                                                    Optional socketCloseTimeout

                                                                                                                                                                    socketCloseTimeout?: number

                                                                                                                                                                    When closing a socket, wait this long for it to close gracefully before it is closed more forcibly

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    backlogcloseServerOnMaxConnectionsdialOptsinboundSocketInactivityTimeoutlistenOptsmaxConnectionsoutboundSocketInactivityTimeoutsocketCloseTimeout
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional outboundSocketInactivityTimeout

                                                                                                                                                                    outboundSocketInactivityTimeout?: number

                                                                                                                                                                    An optional number in ms that is used as an inactivity timeout after which the socket will be closed

                                                                                                                                                                    +

                                                                                                                                                                    Optional socketCloseTimeout

                                                                                                                                                                    socketCloseTimeout?: number

                                                                                                                                                                    When closing a socket, wait this long for it to close gracefully before it is closed more forcibly

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    backlogcloseServerOnMaxConnectionsdialOptsinboundSocketInactivityTimeoutlistenOptsmaxConnectionsoutboundSocketInactivityTimeoutsocketCloseTimeout
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tcp.TCPSocketOptions.html b/interfaces/_libp2p_tcp.TCPSocketOptions.html index bcab506558..796b40b27d 100644 --- a/interfaces/_libp2p_tcp.TCPSocketOptions.html +++ b/interfaces/_libp2p_tcp.TCPSocketOptions.html @@ -1,11 +1,11 @@ TCPSocketOptions | libp2p

                                                                                                                                                                    Interface TCPSocketOptions

                                                                                                                                                                    Expose a subset of net.connect options

                                                                                                                                                                    -
                                                                                                                                                                    interface TCPSocketOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? +
                                                                                                                                                                    interface TCPSocketOptions {
                                                                                                                                                                        allowHalfOpen?: boolean;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    allowHalfOpen? keepAlive? keepAliveInitialDelay? noDelay? signal?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional allowHalfOpen

                                                                                                                                                                    allowHalfOpen?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#new-netsocketoptions

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    -

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelaysignal
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional keepAliveInitialDelay

                                                                                                                                                                    keepAliveInitialDelay?: number

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional noDelay

                                                                                                                                                                    noDelay?: boolean

                                                                                                                                                                    See

                                                                                                                                                                    https://nodejs.org/api/net.html#socketconnectoptions-connectlistener

                                                                                                                                                                    +

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    allowHalfOpenkeepAlivekeepAliveInitialDelaynoDelaysignal
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tls.TLSComponents.html b/interfaces/_libp2p_tls.TLSComponents.html index 7b78a2df01..b0eba5e86c 100644 --- a/interfaces/_libp2p_tls.TLSComponents.html +++ b/interfaces/_libp2p_tls.TLSComponents.html @@ -1,2 +1,2 @@ -TLSComponents | libp2p

                                                                                                                                                                    Interface TLSComponents

                                                                                                                                                                    interface TLSComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    logger
                                                                                                                                                                    \ No newline at end of file +TLSComponents | libp2p

                                                                                                                                                                    Interface TLSComponents

                                                                                                                                                                    interface TLSComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    logger
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_tls.TLSInit.html b/interfaces/_libp2p_tls.TLSInit.html index 0a80f0f49b..aa4a48962a 100644 --- a/interfaces/_libp2p_tls.TLSInit.html +++ b/interfaces/_libp2p_tls.TLSInit.html @@ -1,4 +1,4 @@ -TLSInit | libp2p

                                                                                                                                                                    Interface TLSInit

                                                                                                                                                                    interface TLSInit {
                                                                                                                                                                        timeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    timeout? +TLSInit | libp2p

                                                                                                                                                                    Interface TLSInit

                                                                                                                                                                    interface TLSInit {
                                                                                                                                                                        timeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    timeout?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional timeout

                                                                                                                                                                    timeout?: number

                                                                                                                                                                    The peer id exchange must complete within this many milliseconds (default: 1000)

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    timeout
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    timeout
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.PMPOptions.html b/interfaces/_libp2p_upnp_nat.PMPOptions.html index 7d8e4d7687..09f851ac28 100644 --- a/interfaces/_libp2p_upnp_nat.PMPOptions.html +++ b/interfaces/_libp2p_upnp_nat.PMPOptions.html @@ -1,3 +1,3 @@ -PMPOptions | libp2p

                                                                                                                                                                    Interface PMPOptions

                                                                                                                                                                    interface PMPOptions {
                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    enabled? +PMPOptions | libp2p

                                                                                                                                                                    Interface PMPOptions

                                                                                                                                                                    interface PMPOptions {
                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    enabled?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional enabled

                                                                                                                                                                    enabled?: boolean

                                                                                                                                                                    Whether to enable PMP as well as UPnP

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    enabled
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    enabled
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNAT.html b/interfaces/_libp2p_upnp_nat.UPnPNAT.html index db17452c41..ff819b0b71 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNAT.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNAT.html @@ -1,2 +1,2 @@ -UPnPNAT | libp2p

                                                                                                                                                                    Interface UPnPNAT

                                                                                                                                                                    interface UPnPNAT {
                                                                                                                                                                        client: NatAPI;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    client -

                                                                                                                                                                    Properties

                                                                                                                                                                    client

                                                                                                                                                                    client: NatAPI

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    client
                                                                                                                                                                    \ No newline at end of file +UPnPNAT | libp2p

                                                                                                                                                                    Interface UPnPNAT

                                                                                                                                                                    interface UPnPNAT {
                                                                                                                                                                        client: NatAPI;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    client +

                                                                                                                                                                    Properties

                                                                                                                                                                    client

                                                                                                                                                                    client: NatAPI

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    client
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html b/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html index f1c734022a..9188441a5f 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html @@ -1,6 +1,6 @@ -UPnPNATComponents | libp2p

                                                                                                                                                                    Interface UPnPNATComponents

                                                                                                                                                                    interface UPnPNATComponents {
                                                                                                                                                                        addressManager: AddressManager;
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        nodeInfo: NodeInfo;
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                        transportManager: TransportManager;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    addressManager +UPnPNATComponents | libp2p

                                                                                                                                                                    Interface UPnPNATComponents

                                                                                                                                                                    interface UPnPNATComponents {
                                                                                                                                                                        addressManager: AddressManager;
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        nodeInfo: NodeInfo;
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                        transportManager: TransportManager;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    addressManager logger nodeInfo peerId transportManager -

                                                                                                                                                                    Properties

                                                                                                                                                                    addressManager

                                                                                                                                                                    addressManager: AddressManager

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    nodeInfo

                                                                                                                                                                    nodeInfo: NodeInfo

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    transportManager

                                                                                                                                                                    transportManager: TransportManager

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    addressManagerloggernodeInfopeerIdtransportManager
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    addressManager

                                                                                                                                                                    addressManager: AddressManager

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    nodeInfo

                                                                                                                                                                    nodeInfo: NodeInfo

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    transportManager

                                                                                                                                                                    transportManager: TransportManager

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    addressManagerloggernodeInfopeerIdtransportManager
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_upnp_nat.UPnPNATInit.html b/interfaces/_libp2p_upnp_nat.UPnPNATInit.html index e661b4df29..2f412e9e80 100644 --- a/interfaces/_libp2p_upnp_nat.UPnPNATInit.html +++ b/interfaces/_libp2p_upnp_nat.UPnPNATInit.html @@ -1,13 +1,13 @@ -UPnPNATInit | libp2p

                                                                                                                                                                    Interface UPnPNATInit

                                                                                                                                                                    interface UPnPNATInit {
                                                                                                                                                                        description?: string;
                                                                                                                                                                        externalAddress?: string;
                                                                                                                                                                        gateway?: string;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                        ttl?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    description? +UPnPNATInit | libp2p

                                                                                                                                                                    Interface UPnPNATInit

                                                                                                                                                                    interface UPnPNATInit {
                                                                                                                                                                        description?: string;
                                                                                                                                                                        externalAddress?: string;
                                                                                                                                                                        gateway?: string;
                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                        ttl?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    description? externalAddress? gateway? keepAlive? localAddress? ttl?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional description

                                                                                                                                                                    description?: string

                                                                                                                                                                    A string value to use for the port mapping description on the gateway

                                                                                                                                                                    -

                                                                                                                                                                    Optional externalAddress

                                                                                                                                                                    externalAddress?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    -

                                                                                                                                                                    Optional gateway

                                                                                                                                                                    gateway?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    -

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    Whether to automatically refresh UPnP port mappings when their TTL is reached

                                                                                                                                                                    -

                                                                                                                                                                    Optional localAddress

                                                                                                                                                                    localAddress?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    -

                                                                                                                                                                    Optional ttl

                                                                                                                                                                    ttl?: number

                                                                                                                                                                    How long UPnP port mappings should last for in seconds (minimum 1200)

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    descriptionexternalAddressgatewaykeepAlivelocalAddressttl
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional externalAddress

                                                                                                                                                                    externalAddress?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    +

                                                                                                                                                                    Optional gateway

                                                                                                                                                                    gateway?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    +

                                                                                                                                                                    Optional keepAlive

                                                                                                                                                                    keepAlive?: boolean

                                                                                                                                                                    Whether to automatically refresh UPnP port mappings when their TTL is reached

                                                                                                                                                                    +

                                                                                                                                                                    Optional localAddress

                                                                                                                                                                    localAddress?: string

                                                                                                                                                                    Pass a value to use instead of auto-detection

                                                                                                                                                                    +

                                                                                                                                                                    Optional ttl

                                                                                                                                                                    ttl?: number

                                                                                                                                                                    How long UPnP port mappings should last for in seconds (minimum 1200)

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    descriptionexternalAddressgatewaykeepAlivelocalAddressttl
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html b/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html index 53946b0fed..a097872489 100644 --- a/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html +++ b/interfaces/_libp2p_utils.abstract_stream.AbstractStreamInit.html @@ -1,4 +1,4 @@ -AbstractStreamInit | libp2p

                                                                                                                                                                    Interface AbstractStreamInit

                                                                                                                                                                    interface AbstractStreamInit {
                                                                                                                                                                        closeTimeout?: number;
                                                                                                                                                                        direction: Direction;
                                                                                                                                                                        id: string;
                                                                                                                                                                        log: Logger;
                                                                                                                                                                        metadata?: Record<string, unknown>;
                                                                                                                                                                        sendCloseWriteTimeout?: number;
                                                                                                                                                                        onAbort?(err): void;
                                                                                                                                                                        onCloseRead?(): void;
                                                                                                                                                                        onCloseWrite?(): void;
                                                                                                                                                                        onEnd?(err?): void;
                                                                                                                                                                        onReset?(): void;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    closeTimeout? +AbstractStreamInit | libp2p

                                                                                                                                                                    Interface AbstractStreamInit

                                                                                                                                                                    interface AbstractStreamInit {
                                                                                                                                                                        closeTimeout?: number;
                                                                                                                                                                        direction: Direction;
                                                                                                                                                                        id: string;
                                                                                                                                                                        log: Logger;
                                                                                                                                                                        metadata?: Record<string, unknown>;
                                                                                                                                                                        sendCloseWriteTimeout?: number;
                                                                                                                                                                        onAbort?(err): void;
                                                                                                                                                                        onCloseRead?(): void;
                                                                                                                                                                        onCloseWrite?(): void;
                                                                                                                                                                        onEnd?(err?): void;
                                                                                                                                                                        onReset?(): void;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    closeTimeout? direction id log @@ -11,15 +11,15 @@ onReset?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional closeTimeout

                                                                                                                                                                    closeTimeout?: number

                                                                                                                                                                    How long to wait in ms for stream data to be written to the underlying connection when closing the writable end of the stream. (default: 500)

                                                                                                                                                                    -

                                                                                                                                                                    direction

                                                                                                                                                                    direction: Direction

                                                                                                                                                                    The stream direction

                                                                                                                                                                    -

                                                                                                                                                                    id

                                                                                                                                                                    id: string

                                                                                                                                                                    A unique identifier for this stream

                                                                                                                                                                    -

                                                                                                                                                                    log

                                                                                                                                                                    log: Logger

                                                                                                                                                                    A Logger implementation used to log stream-specific information

                                                                                                                                                                    -

                                                                                                                                                                    Optional metadata

                                                                                                                                                                    metadata?: Record<string, unknown>

                                                                                                                                                                    User specific stream metadata

                                                                                                                                                                    -

                                                                                                                                                                    Optional sendCloseWriteTimeout

                                                                                                                                                                    sendCloseWriteTimeout?: number

                                                                                                                                                                    After the stream sink has closed, a limit on how long it takes to send +

                                                                                                                                                                    direction

                                                                                                                                                                    direction: Direction

                                                                                                                                                                    The stream direction

                                                                                                                                                                    +

                                                                                                                                                                    id

                                                                                                                                                                    id: string

                                                                                                                                                                    A unique identifier for this stream

                                                                                                                                                                    +

                                                                                                                                                                    log

                                                                                                                                                                    log: Logger

                                                                                                                                                                    A Logger implementation used to log stream-specific information

                                                                                                                                                                    +

                                                                                                                                                                    Optional metadata

                                                                                                                                                                    metadata?: Record<string, unknown>

                                                                                                                                                                    User specific stream metadata

                                                                                                                                                                    +

                                                                                                                                                                    Optional sendCloseWriteTimeout

                                                                                                                                                                    sendCloseWriteTimeout?: number

                                                                                                                                                                    After the stream sink has closed, a limit on how long it takes to send a close-write message to the remote peer.

                                                                                                                                                                    -

                                                                                                                                                                    Methods

                                                                                                                                                                    Optional onAbort

                                                                                                                                                                    Optional onCloseRead

                                                                                                                                                                    Optional onCloseWrite

                                                                                                                                                                    Optional onEnd

                                                                                                                                                                    Optional onReset

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closeTimeoutdirectionidlogmetadatasendCloseWriteTimeoutonAbortonCloseReadonCloseWriteonEndonReset
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Methods

                                                                                                                                                                    Optional onAbort

                                                                                                                                                                    Optional onCloseRead

                                                                                                                                                                    Optional onCloseWrite

                                                                                                                                                                    Optional onEnd

                                                                                                                                                                    Optional onReset

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closeTimeoutdirectionidlogmetadatasendCloseWriteTimeoutonAbortonCloseReadonCloseWriteonEndonReset
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html index 37e88b564d..8315a4308d 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutInit.html @@ -1,8 +1,8 @@ -AdaptiveTimeoutInit | libp2p

                                                                                                                                                                    Interface AdaptiveTimeoutInit

                                                                                                                                                                    interface AdaptiveTimeoutInit {
                                                                                                                                                                        failureMultiplier?: number;
                                                                                                                                                                        initialValue?: number;
                                                                                                                                                                        interval?: number;
                                                                                                                                                                        metricName?: string;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        minTimeout?: number;
                                                                                                                                                                        timeoutMultiplier?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    failureMultiplier? +AdaptiveTimeoutInit | libp2p

                                                                                                                                                                    Interface AdaptiveTimeoutInit

                                                                                                                                                                    interface AdaptiveTimeoutInit {
                                                                                                                                                                        failureMultiplier?: number;
                                                                                                                                                                        initialValue?: number;
                                                                                                                                                                        interval?: number;
                                                                                                                                                                        metricName?: string;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        minTimeout?: number;
                                                                                                                                                                        timeoutMultiplier?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    failureMultiplier? initialValue? interval? metricName? metrics? minTimeout? timeoutMultiplier? -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional failureMultiplier

                                                                                                                                                                    failureMultiplier?: number

                                                                                                                                                                    Optional initialValue

                                                                                                                                                                    initialValue?: number

                                                                                                                                                                    Optional interval

                                                                                                                                                                    interval?: number

                                                                                                                                                                    Optional metricName

                                                                                                                                                                    metricName?: string

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Optional minTimeout

                                                                                                                                                                    minTimeout?: number

                                                                                                                                                                    Optional timeoutMultiplier

                                                                                                                                                                    timeoutMultiplier?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    failureMultiplierinitialValueintervalmetricNamemetricsminTimeouttimeoutMultiplier
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional failureMultiplier

                                                                                                                                                                    failureMultiplier?: number

                                                                                                                                                                    Optional initialValue

                                                                                                                                                                    initialValue?: number

                                                                                                                                                                    Optional interval

                                                                                                                                                                    interval?: number

                                                                                                                                                                    Optional metricName

                                                                                                                                                                    metricName?: string

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Optional minTimeout

                                                                                                                                                                    minTimeout?: number

                                                                                                                                                                    Optional timeoutMultiplier

                                                                                                                                                                    timeoutMultiplier?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    failureMultiplierinitialValueintervalmetricNamemetricsminTimeouttimeoutMultiplier
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html index 0f3e8ac7d8..f7b88e0498 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.AdaptiveTimeoutSignal.html @@ -1,4 +1,4 @@ -AdaptiveTimeoutSignal | libp2p

                                                                                                                                                                    Interface AdaptiveTimeoutSignal

                                                                                                                                                                    interface AdaptiveTimeoutSignal {
                                                                                                                                                                        aborted: boolean;
                                                                                                                                                                        clear: (() => void);
                                                                                                                                                                        onabort: null | ((this, ev) => any);
                                                                                                                                                                        reason: any;
                                                                                                                                                                        start: number;
                                                                                                                                                                        timeout: number;
                                                                                                                                                                        addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        addEventListener(type, listener, options?): void;
                                                                                                                                                                        addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        addEventListener(type, listener, options?): void;
                                                                                                                                                                        dispatchEvent(event): boolean;
                                                                                                                                                                        dispatchEvent(event): boolean;
                                                                                                                                                                        removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        removeEventListener(type, listener, options?): void;
                                                                                                                                                                        removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        removeEventListener(type, listener, options?): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy

                                                                                                                                                                    Properties

                                                                                                                                                                    aborted +AdaptiveTimeoutSignal | libp2p

                                                                                                                                                                    Interface AdaptiveTimeoutSignal

                                                                                                                                                                    interface AdaptiveTimeoutSignal {
                                                                                                                                                                        aborted: boolean;
                                                                                                                                                                        clear: (() => void);
                                                                                                                                                                        onabort: null | ((this, ev) => any);
                                                                                                                                                                        reason: any;
                                                                                                                                                                        start: number;
                                                                                                                                                                        timeout: number;
                                                                                                                                                                        addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        addEventListener(type, listener, options?): void;
                                                                                                                                                                        addEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        addEventListener(type, listener, options?): void;
                                                                                                                                                                        dispatchEvent(event): boolean;
                                                                                                                                                                        dispatchEvent(event): boolean;
                                                                                                                                                                        removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        removeEventListener(type, listener, options?): void;
                                                                                                                                                                        removeEventListener<K>(type, listener, options?): void;
                                                                                                                                                                        removeEventListener(type, listener, options?): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy

                                                                                                                                                                    Properties

                                                                                                                                                                    aborted clear onabort reason @@ -12,7 +12,7 @@

                                                                                                                                                                    MDN Reference

                                                                                                                                                                    clear

                                                                                                                                                                    clear: (() => void)

                                                                                                                                                                    Type declaration

                                                                                                                                                                      • (): void

                                                                                                                                                                      • Returns void

                                                                                                                                                                    onabort

                                                                                                                                                                    onabort: null | ((this, ev) => any)

                                                                                                                                                                    MDN Reference

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Readonly reason

                                                                                                                                                                    reason: any

                                                                                                                                                                    MDN Reference

                                                                                                                                                                    -

                                                                                                                                                                    start

                                                                                                                                                                    start: number

                                                                                                                                                                    timeout

                                                                                                                                                                    timeout: number

                                                                                                                                                                    Methods

                                                                                                                                                                    addEventListener

                                                                                                                                                                    • addEventListener<K>(type, listener, options?): void

                                                                                                                                                                    • Type Parameters

                                                                                                                                                                      • K extends "abort"

                                                                                                                                                                      Parameters

                                                                                                                                                                      • type: K
                                                                                                                                                                      • listener: ((this, ev) => any)
                                                                                                                                                                          • (this, ev): any

                                                                                                                                                                          • Parameters

                                                                                                                                                                            Returns any

                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener(type, listener, options?): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      • type: string
                                                                                                                                                                      • listener: EventListenerOrEventListenerObject
                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener<K>(type, listener, options?): void

                                                                                                                                                                    • Type Parameters

                                                                                                                                                                      • K extends "abort"

                                                                                                                                                                      Parameters

                                                                                                                                                                      • type: K
                                                                                                                                                                      • listener: ((this, ev) => any)
                                                                                                                                                                          • (this, ev): any

                                                                                                                                                                          • Parameters

                                                                                                                                                                            Returns any

                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener(type, listener, options?): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      • type: string
                                                                                                                                                                      • listener: EventListenerOrEventListenerObject
                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    dispatchEvent

                                                                                                                                                                    • dispatchEvent(event): boolean

                                                                                                                                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                      +

                                                                                                                                                                    start

                                                                                                                                                                    start: number

                                                                                                                                                                    timeout

                                                                                                                                                                    timeout: number

                                                                                                                                                                    Methods

                                                                                                                                                                    addEventListener

                                                                                                                                                                    • addEventListener<K>(type, listener, options?): void

                                                                                                                                                                    • Type Parameters

                                                                                                                                                                      • K extends "abort"

                                                                                                                                                                      Parameters

                                                                                                                                                                      • type: K
                                                                                                                                                                      • listener: ((this, ev) => any)
                                                                                                                                                                          • (this, ev): any

                                                                                                                                                                          • Parameters

                                                                                                                                                                            Returns any

                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener(type, listener, options?): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      • type: string
                                                                                                                                                                      • listener: EventListenerOrEventListenerObject
                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener<K>(type, listener, options?): void

                                                                                                                                                                    • Type Parameters

                                                                                                                                                                      • K extends "abort"

                                                                                                                                                                      Parameters

                                                                                                                                                                      • type: K
                                                                                                                                                                      • listener: ((this, ev) => any)
                                                                                                                                                                          • (this, ev): any

                                                                                                                                                                          • Parameters

                                                                                                                                                                            Returns any

                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    • addEventListener(type, listener, options?): void

                                                                                                                                                                    • Parameters

                                                                                                                                                                      • type: string
                                                                                                                                                                      • listener: EventListenerOrEventListenerObject
                                                                                                                                                                      • Optional options: boolean | AddEventListenerOptions

                                                                                                                                                                      Returns void

                                                                                                                                                                    dispatchEvent

                                                                                                                                                                    • dispatchEvent(event): boolean

                                                                                                                                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                      MDN Reference

                                                                                                                                                                      Parameters

                                                                                                                                                                      Returns boolean

                                                                                                                                                                    • dispatchEvent(event): boolean

                                                                                                                                                                    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

                                                                                                                                                                      MDN Reference

                                                                                                                                                                      diff --git a/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html b/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html index db329dcafa..82fe1244de 100644 --- a/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html +++ b/interfaces/_libp2p_utils.adaptive_timeout.GetTimeoutSignalOptions.html @@ -1,3 +1,3 @@ -GetTimeoutSignalOptions | libp2p

                                                                                                                                                                      Interface GetTimeoutSignalOptions

                                                                                                                                                                      interface GetTimeoutSignalOptions {
                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                          timeoutFactor?: number;
                                                                                                                                                                      }

                                                                                                                                                                      Properties

                                                                                                                                                                      signal? +GetTimeoutSignalOptions | libp2p

                                                                                                                                                                      Interface GetTimeoutSignalOptions

                                                                                                                                                                      interface GetTimeoutSignalOptions {
                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                          timeoutFactor?: number;
                                                                                                                                                                      }

                                                                                                                                                                      Properties

                                                                                                                                                                      signal? timeoutFactor? -

                                                                                                                                                                      Properties

                                                                                                                                                                      Optional signal

                                                                                                                                                                      signal?: AbortSignal

                                                                                                                                                                      Optional timeoutFactor

                                                                                                                                                                      timeoutFactor?: number

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      Theme

                                                                                                                                                                      On This Page

                                                                                                                                                                      signaltimeoutFactor
                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                      Properties

                                                                                                                                                                      Optional signal

                                                                                                                                                                      signal?: AbortSignal

                                                                                                                                                                      Optional timeoutFactor

                                                                                                                                                                      timeoutFactor?: number

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      Theme

                                                                                                                                                                      On This Page

                                                                                                                                                                      signaltimeoutFactor
                                                                                                                                                                      \ No newline at end of file diff --git a/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html b/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html index ce87223ec6..0c7f452f3e 100644 --- a/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html +++ b/interfaces/_libp2p_utils.close.SafelyCloseConnectionOptions.html @@ -2,10 +2,10 @@ the optional signal property.

                                                                                                                                                                      Example

                                                                                                                                                                      const controller = new AbortController()

                                                                                                                                                                      aLongRunningOperation({
                                                                                                                                                                        signal: controller.signal
                                                                                                                                                                      })

                                                                                                                                                                      // later

                                                                                                                                                                      controller.abort()
                                                                                                                                                                      -
                                                                                                                                                                    interface SafelyCloseConnectionOptions {
                                                                                                                                                                        closableProtocols?: string[];
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    closableProtocols? +
                                                                                                                                                                    interface SafelyCloseConnectionOptions {
                                                                                                                                                                        closableProtocols?: string[];
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    closableProtocols? signal?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional closableProtocols

                                                                                                                                                                    closableProtocols?: string[]

                                                                                                                                                                    Only close the stream if it either has no protocol streams open or only ones in this list.

                                                                                                                                                                    Default

                                                                                                                                                                    ['/ipfs/id/1.0.0']
                                                                                                                                                                    -

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closableProtocolssignal
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closableProtocolssignal
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.BloomFilterOptions.html b/interfaces/_libp2p_utils.filters.BloomFilterOptions.html index bcbd7a7860..c7e9641caf 100644 --- a/interfaces/_libp2p_utils.filters.BloomFilterOptions.html +++ b/interfaces/_libp2p_utils.filters.BloomFilterOptions.html @@ -1,4 +1,4 @@ -BloomFilterOptions | libp2p

                                                                                                                                                                    Interface BloomFilterOptions

                                                                                                                                                                    interface BloomFilterOptions {
                                                                                                                                                                        bits?: number;
                                                                                                                                                                        hashes?: number;
                                                                                                                                                                        seeds?: number[];
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    bits? +BloomFilterOptions | libp2p

                                                                                                                                                                    Interface BloomFilterOptions

                                                                                                                                                                    interface BloomFilterOptions {
                                                                                                                                                                        bits?: number;
                                                                                                                                                                        hashes?: number;
                                                                                                                                                                        seeds?: number[];
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    bits? hashes? seeds? -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional bits

                                                                                                                                                                    bits?: number

                                                                                                                                                                    Optional hashes

                                                                                                                                                                    hashes?: number

                                                                                                                                                                    Optional seeds

                                                                                                                                                                    seeds?: number[]

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bitshashesseeds
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional bits

                                                                                                                                                                    bits?: number

                                                                                                                                                                    Optional hashes

                                                                                                                                                                    hashes?: number

                                                                                                                                                                    Optional seeds

                                                                                                                                                                    seeds?: number[]

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bitshashesseeds
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.CuckooFilterInit.html b/interfaces/_libp2p_utils.filters.CuckooFilterInit.html index 261ee61cdb..108c467559 100644 --- a/interfaces/_libp2p_utils.filters.CuckooFilterInit.html +++ b/interfaces/_libp2p_utils.filters.CuckooFilterInit.html @@ -1,11 +1,11 @@ -CuckooFilterInit | libp2p

                                                                                                                                                                    Interface CuckooFilterInit

                                                                                                                                                                    interface CuckooFilterInit {
                                                                                                                                                                        bucketSize?: number;
                                                                                                                                                                        filterSize: number;
                                                                                                                                                                        fingerprintSize?: number;
                                                                                                                                                                        hash?: Hash;
                                                                                                                                                                        seed?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    bucketSize? +CuckooFilterInit | libp2p

                                                                                                                                                                    Interface CuckooFilterInit

                                                                                                                                                                    interface CuckooFilterInit {
                                                                                                                                                                        bucketSize?: number;
                                                                                                                                                                        filterSize: number;
                                                                                                                                                                        fingerprintSize?: number;
                                                                                                                                                                        hash?: Hash;
                                                                                                                                                                        seed?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    bucketSize? filterSize fingerprintSize? hash? seed?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional bucketSize

                                                                                                                                                                    bucketSize?: number

                                                                                                                                                                    How many items to put in each bucket

                                                                                                                                                                    -

                                                                                                                                                                    filterSize

                                                                                                                                                                    filterSize: number

                                                                                                                                                                    How many items the filter is expected to contain

                                                                                                                                                                    -

                                                                                                                                                                    Optional fingerprintSize

                                                                                                                                                                    fingerprintSize?: number

                                                                                                                                                                    How many bytes the fingerprint is expected to be

                                                                                                                                                                    -

                                                                                                                                                                    Optional hash

                                                                                                                                                                    hash?: Hash

                                                                                                                                                                    A non-cryptographic hash implementation

                                                                                                                                                                    -

                                                                                                                                                                    Optional seed

                                                                                                                                                                    seed?: number

                                                                                                                                                                    A number used to seed the hash

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bucketSizefilterSizefingerprintSizehashseed
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    filterSize

                                                                                                                                                                    filterSize: number

                                                                                                                                                                    How many items the filter is expected to contain

                                                                                                                                                                    +

                                                                                                                                                                    Optional fingerprintSize

                                                                                                                                                                    fingerprintSize?: number

                                                                                                                                                                    How many bytes the fingerprint is expected to be

                                                                                                                                                                    +

                                                                                                                                                                    Optional hash

                                                                                                                                                                    hash?: Hash

                                                                                                                                                                    A non-cryptographic hash implementation

                                                                                                                                                                    +

                                                                                                                                                                    Optional seed

                                                                                                                                                                    seed?: number

                                                                                                                                                                    A number used to seed the hash

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bucketSizefilterSizefingerprintSizehashseed
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.Filter.html b/interfaces/_libp2p_utils.filters.Filter.html index 6181eb5c28..81a3102955 100644 --- a/interfaces/_libp2p_utils.filters.Filter.html +++ b/interfaces/_libp2p_utils.filters.Filter.html @@ -1,4 +1,4 @@ -Filter | libp2p

                                                                                                                                                                    Interface Filter

                                                                                                                                                                    interface Filter {
                                                                                                                                                                        add(item): void;
                                                                                                                                                                        has(item): boolean;
                                                                                                                                                                        remove?(buf): boolean;
                                                                                                                                                                    }

                                                                                                                                                                    Implemented by

                                                                                                                                                                    Methods

                                                                                                                                                                    add +Filter | libp2p

                                                                                                                                                                    Interface Filter

                                                                                                                                                                    interface Filter {
                                                                                                                                                                        add(item): void;
                                                                                                                                                                        has(item): boolean;
                                                                                                                                                                        remove?(buf): boolean;
                                                                                                                                                                    }

                                                                                                                                                                    Implemented by

                                                                                                                                                                    Methods

                                                                                                                                                                    add has remove? -

                                                                                                                                                                    Methods

                                                                                                                                                                    add

                                                                                                                                                                    has

                                                                                                                                                                    Optional remove

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    addhasremove
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Methods

                                                                                                                                                                    add

                                                                                                                                                                    has

                                                                                                                                                                    Optional remove

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    addhasremove
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html b/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html index c2dde131c6..13a0c857d7 100644 --- a/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html +++ b/interfaces/_libp2p_utils.filters.ScalableCuckooFilterInit.html @@ -1,13 +1,13 @@ -ScalableCuckooFilterInit | libp2p

                                                                                                                                                                    Interface ScalableCuckooFilterInit

                                                                                                                                                                    interface ScalableCuckooFilterInit {
                                                                                                                                                                        bucketSize?: number;
                                                                                                                                                                        filterSize: number;
                                                                                                                                                                        fingerprintSize?: number;
                                                                                                                                                                        hash?: Hash;
                                                                                                                                                                        scale?: number;
                                                                                                                                                                        seed?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    bucketSize? +ScalableCuckooFilterInit | libp2p

                                                                                                                                                                    Interface ScalableCuckooFilterInit

                                                                                                                                                                    interface ScalableCuckooFilterInit {
                                                                                                                                                                        bucketSize?: number;
                                                                                                                                                                        filterSize: number;
                                                                                                                                                                        fingerprintSize?: number;
                                                                                                                                                                        hash?: Hash;
                                                                                                                                                                        scale?: number;
                                                                                                                                                                        seed?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    bucketSize? filterSize fingerprintSize? hash? scale? seed?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional bucketSize

                                                                                                                                                                    bucketSize?: number

                                                                                                                                                                    How many items to put in each bucket

                                                                                                                                                                    -

                                                                                                                                                                    filterSize

                                                                                                                                                                    filterSize: number

                                                                                                                                                                    How many items the filter is expected to contain

                                                                                                                                                                    -

                                                                                                                                                                    Optional fingerprintSize

                                                                                                                                                                    fingerprintSize?: number

                                                                                                                                                                    How many bytes the fingerprint is expected to be

                                                                                                                                                                    -

                                                                                                                                                                    Optional hash

                                                                                                                                                                    hash?: Hash

                                                                                                                                                                    A non-cryptographic hash implementation

                                                                                                                                                                    -

                                                                                                                                                                    Optional scale

                                                                                                                                                                    scale?: number

                                                                                                                                                                    A number to multiply maxItems by when adding new sub-filters

                                                                                                                                                                    -

                                                                                                                                                                    Optional seed

                                                                                                                                                                    seed?: number

                                                                                                                                                                    A number used to seed the hash

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bucketSizefilterSizefingerprintSizehashscaleseed
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    filterSize

                                                                                                                                                                    filterSize: number

                                                                                                                                                                    How many items the filter is expected to contain

                                                                                                                                                                    +

                                                                                                                                                                    Optional fingerprintSize

                                                                                                                                                                    fingerprintSize?: number

                                                                                                                                                                    How many bytes the fingerprint is expected to be

                                                                                                                                                                    +

                                                                                                                                                                    Optional hash

                                                                                                                                                                    hash?: Hash

                                                                                                                                                                    A non-cryptographic hash implementation

                                                                                                                                                                    +

                                                                                                                                                                    Optional scale

                                                                                                                                                                    scale?: number

                                                                                                                                                                    A number to multiply maxItems by when adding new sub-filters

                                                                                                                                                                    +

                                                                                                                                                                    Optional seed

                                                                                                                                                                    seed?: number

                                                                                                                                                                    A number used to seed the hash

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bucketSizefilterSizefingerprintSizehashscaleseed
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html b/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html index e0a21f5c1c..6e79f109f3 100644 --- a/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html +++ b/interfaces/_libp2p_utils.peer_queue.PeerQueueJobOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                                                                                                                                                    Example

                                                                                                                                                                    const controller = new AbortController()

                                                                                                                                                                    aLongRunningOperation({
                                                                                                                                                                      signal: controller.signal
                                                                                                                                                                    })

                                                                                                                                                                    // later

                                                                                                                                                                    controller.abort()
                                                                                                                                                                    -
                                                                                                                                                                    interface PeerQueueJobOptions {
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    peerId +
                                                                                                                                                                    interface PeerQueueJobOptions {
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    peerId signal? -

                                                                                                                                                                    Properties

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    peerIdsignal
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    peerIdsignal
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html b/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html index 9cd2b91cbd..eb58b289d6 100644 --- a/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html +++ b/interfaces/_libp2p_utils.priority_queue.PriorityQueueJobOptions.html @@ -2,6 +2,6 @@ the optional signal property.

                                                                                                                                                                    Example

                                                                                                                                                                    const controller = new AbortController()

                                                                                                                                                                    aLongRunningOperation({
                                                                                                                                                                      signal: controller.signal
                                                                                                                                                                    })

                                                                                                                                                                    // later

                                                                                                                                                                    controller.abort()
                                                                                                                                                                    -
                                                                                                                                                                    interface PriorityQueueJobOptions {
                                                                                                                                                                        priority: number;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    priority +
                                                                                                                                                                    interface PriorityQueueJobOptions {
                                                                                                                                                                        priority: number;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    priority signal? -

                                                                                                                                                                    Properties

                                                                                                                                                                    priority

                                                                                                                                                                    priority: number

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    prioritysignal
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    priority

                                                                                                                                                                    priority: number

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    prioritysignal
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.Comparator.html b/interfaces/_libp2p_utils.queue.Comparator.html index 264c9b0f4f..7e8a4278af 100644 --- a/interfaces/_libp2p_utils.queue.Comparator.html +++ b/interfaces/_libp2p_utils.queue.Comparator.html @@ -1 +1 @@ -Comparator | libp2p

                                                                                                                                                                    Interface Comparator<T>

                                                                                                                                                                    interface Comparator<T> ((a, b) => -1 | 0 | 1)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    • T

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file +Comparator | libp2p

                                                                                                                                                                    Interface Comparator<T>

                                                                                                                                                                    interface Comparator<T> ((a, b) => -1 | 0 | 1)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    • T

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.JobMatcher.html b/interfaces/_libp2p_utils.queue.JobMatcher.html index c4abcd9eb0..da580e7446 100644 --- a/interfaces/_libp2p_utils.queue.JobMatcher.html +++ b/interfaces/_libp2p_utils.queue.JobMatcher.html @@ -1 +1 @@ -JobMatcher | libp2p

                                                                                                                                                                    Interface JobMatcher<JobOptions>

                                                                                                                                                                    interface JobMatcher<JobOptions> ((options?) => boolean)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file +JobMatcher | libp2p

                                                                                                                                                                    Interface JobMatcher<JobOptions>

                                                                                                                                                                    interface JobMatcher<JobOptions> ((options?) => boolean)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueEvents.html b/interfaces/_libp2p_utils.queue.QueueEvents.html index fc942cede8..2a9ef3a8b8 100644 --- a/interfaces/_libp2p_utils.queue.QueueEvents.html +++ b/interfaces/_libp2p_utils.queue.QueueEvents.html @@ -1,4 +1,4 @@ -QueueEvents | libp2p

                                                                                                                                                                    Interface QueueEvents<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueEvents<JobReturnType, JobOptions> {
                                                                                                                                                                        active: CustomEvent<any>;
                                                                                                                                                                        add: CustomEvent<any>;
                                                                                                                                                                        completed: CustomEvent<JobReturnType>;
                                                                                                                                                                        empty: CustomEvent<any>;
                                                                                                                                                                        error: CustomEvent<Error>;
                                                                                                                                                                        failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>;
                                                                                                                                                                        idle: CustomEvent<any>;
                                                                                                                                                                        next: CustomEvent<any>;
                                                                                                                                                                        success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    active +QueueEvents | libp2p

                                                                                                                                                                    Interface QueueEvents<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueEvents<JobReturnType, JobOptions> {
                                                                                                                                                                        active: CustomEvent<any>;
                                                                                                                                                                        add: CustomEvent<any>;
                                                                                                                                                                        completed: CustomEvent<JobReturnType>;
                                                                                                                                                                        empty: CustomEvent<any>;
                                                                                                                                                                        error: CustomEvent<Error>;
                                                                                                                                                                        failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>;
                                                                                                                                                                        idle: CustomEvent<any>;
                                                                                                                                                                        next: CustomEvent<any>;
                                                                                                                                                                        success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    active add completed empty @@ -8,14 +8,14 @@ next success

                                                                                                                                                                    Properties

                                                                                                                                                                    active

                                                                                                                                                                    active: CustomEvent<any>

                                                                                                                                                                    A job is about to start running

                                                                                                                                                                    -

                                                                                                                                                                    add

                                                                                                                                                                    add: CustomEvent<any>

                                                                                                                                                                    A job was added to the queue

                                                                                                                                                                    -

                                                                                                                                                                    completed

                                                                                                                                                                    completed: CustomEvent<JobReturnType>

                                                                                                                                                                    A job has finished successfully

                                                                                                                                                                    -

                                                                                                                                                                    empty

                                                                                                                                                                    empty: CustomEvent<any>

                                                                                                                                                                    The queue is empty, jobs may be running

                                                                                                                                                                    -

                                                                                                                                                                    error

                                                                                                                                                                    error: CustomEvent<Error>

                                                                                                                                                                    A job has failed

                                                                                                                                                                    -

                                                                                                                                                                    failure

                                                                                                                                                                    failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>

                                                                                                                                                                    Emitted just after `"error", a job has failed - this event gives access to +

                                                                                                                                                                    add

                                                                                                                                                                    add: CustomEvent<any>

                                                                                                                                                                    A job was added to the queue

                                                                                                                                                                    +

                                                                                                                                                                    completed

                                                                                                                                                                    completed: CustomEvent<JobReturnType>

                                                                                                                                                                    A job has finished successfully

                                                                                                                                                                    +

                                                                                                                                                                    empty

                                                                                                                                                                    empty: CustomEvent<any>

                                                                                                                                                                    The queue is empty, jobs may be running

                                                                                                                                                                    +

                                                                                                                                                                    error

                                                                                                                                                                    error: CustomEvent<Error>

                                                                                                                                                                    A job has failed

                                                                                                                                                                    +

                                                                                                                                                                    failure

                                                                                                                                                                    failure: CustomEvent<QueueJobFailure<JobReturnType, JobOptions>>

                                                                                                                                                                    Emitted just after `"error", a job has failed - this event gives access to the job and the thrown error

                                                                                                                                                                    -

                                                                                                                                                                    idle

                                                                                                                                                                    idle: CustomEvent<any>

                                                                                                                                                                    All jobs have finished and the queue is empty

                                                                                                                                                                    -

                                                                                                                                                                    next

                                                                                                                                                                    next: CustomEvent<any>

                                                                                                                                                                    A job has finished or failed

                                                                                                                                                                    -

                                                                                                                                                                    success

                                                                                                                                                                    success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>

                                                                                                                                                                    Emitted just after `"completed", a job has finished successfully - this +

                                                                                                                                                                    idle

                                                                                                                                                                    idle: CustomEvent<any>

                                                                                                                                                                    All jobs have finished and the queue is empty

                                                                                                                                                                    +

                                                                                                                                                                    next

                                                                                                                                                                    next: CustomEvent<any>

                                                                                                                                                                    A job has finished or failed

                                                                                                                                                                    +

                                                                                                                                                                    success

                                                                                                                                                                    success: CustomEvent<QueueJobSuccess<JobReturnType, JobOptions>>

                                                                                                                                                                    Emitted just after `"completed", a job has finished successfully - this event gives access to the job and it's result

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    activeaddcompletedemptyerrorfailureidlenextsuccess
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    activeaddcompletedemptyerrorfailureidlenextsuccess
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueInit.html b/interfaces/_libp2p_utils.queue.QueueInit.html index 6226e0f4ee..6ffa6970b5 100644 --- a/interfaces/_libp2p_utils.queue.QueueInit.html +++ b/interfaces/_libp2p_utils.queue.QueueInit.html @@ -1,4 +1,4 @@ -QueueInit | libp2p

                                                                                                                                                                    Interface QueueInit<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueInit<JobReturnType, JobOptions> {
                                                                                                                                                                        concurrency?: number;
                                                                                                                                                                        metricName?: string;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        sort?: Comparator<Job<JobOptions, JobReturnType>>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    concurrency? +QueueInit | libp2p

                                                                                                                                                                    Interface QueueInit<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueInit<JobReturnType, JobOptions> {
                                                                                                                                                                        concurrency?: number;
                                                                                                                                                                        metricName?: string;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        sort?: Comparator<Job<JobOptions, JobReturnType>>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    concurrency? metricName? metrics? sort? @@ -6,7 +6,7 @@

                                                                                                                                                                    Minimum: 1.

                                                                                                                                                                    Default

                                                                                                                                                                    Infinity
                                                                                                                                                                    -

                                                                                                                                                                    Optional metricName

                                                                                                                                                                    metricName?: string

                                                                                                                                                                    The name of the metric for the queue length

                                                                                                                                                                    -

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    An implementation of the libp2p Metrics interface

                                                                                                                                                                    -

                                                                                                                                                                    Optional sort

                                                                                                                                                                    sort?: Comparator<Job<JobOptions, JobReturnType>>

                                                                                                                                                                    An optional function that will sort the queue after a job has been added

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    concurrencymetricNamemetricssort
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Optional metricName

                                                                                                                                                                    metricName?: string

                                                                                                                                                                    The name of the metric for the queue length

                                                                                                                                                                    +

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    An implementation of the libp2p Metrics interface

                                                                                                                                                                    +

                                                                                                                                                                    Optional sort

                                                                                                                                                                    sort?: Comparator<Job<JobOptions, JobReturnType>>

                                                                                                                                                                    An optional function that will sort the queue after a job has been added

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    concurrencymetricNamemetricssort
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueJobFailure.html b/interfaces/_libp2p_utils.queue.QueueJobFailure.html index 223fff418e..ee5ebeab4f 100644 --- a/interfaces/_libp2p_utils.queue.QueueJobFailure.html +++ b/interfaces/_libp2p_utils.queue.QueueJobFailure.html @@ -1,3 +1,3 @@ -QueueJobFailure | libp2p

                                                                                                                                                                    Interface QueueJobFailure<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueJobFailure<JobReturnType, JobOptions> {
                                                                                                                                                                        error: Error;
                                                                                                                                                                        job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    error +QueueJobFailure | libp2p

                                                                                                                                                                    Interface QueueJobFailure<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueJobFailure<JobReturnType, JobOptions> {
                                                                                                                                                                        error: Error;
                                                                                                                                                                        job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    error job -

                                                                                                                                                                    Properties

                                                                                                                                                                    error

                                                                                                                                                                    error: Error

                                                                                                                                                                    job

                                                                                                                                                                    job: Job<JobOptions, JobReturnType>

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    errorjob
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    error

                                                                                                                                                                    error: Error

                                                                                                                                                                    job

                                                                                                                                                                    job: Job<JobOptions, JobReturnType>

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    errorjob
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.QueueJobSuccess.html b/interfaces/_libp2p_utils.queue.QueueJobSuccess.html index 0c31545758..2e50cadc2c 100644 --- a/interfaces/_libp2p_utils.queue.QueueJobSuccess.html +++ b/interfaces/_libp2p_utils.queue.QueueJobSuccess.html @@ -1,3 +1,3 @@ -QueueJobSuccess | libp2p

                                                                                                                                                                    Interface QueueJobSuccess<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueJobSuccess<JobReturnType, JobOptions> {
                                                                                                                                                                        job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                        result: JobReturnType;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    job +QueueJobSuccess | libp2p

                                                                                                                                                                    Interface QueueJobSuccess<JobReturnType, JobOptions>

                                                                                                                                                                    interface QueueJobSuccess<JobReturnType, JobOptions> {
                                                                                                                                                                        job: Job<JobOptions, JobReturnType>;
                                                                                                                                                                        result: JobReturnType;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    job result -

                                                                                                                                                                    Properties

                                                                                                                                                                    job

                                                                                                                                                                    job: Job<JobOptions, JobReturnType>

                                                                                                                                                                    result

                                                                                                                                                                    result: JobReturnType

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    jobresult
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    job

                                                                                                                                                                    job: Job<JobOptions, JobReturnType>

                                                                                                                                                                    result

                                                                                                                                                                    result: JobReturnType

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    jobresult
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.queue.RunFunction.html b/interfaces/_libp2p_utils.queue.RunFunction.html index 4f1c7a0f15..2787f6d4ee 100644 --- a/interfaces/_libp2p_utils.queue.RunFunction.html +++ b/interfaces/_libp2p_utils.queue.RunFunction.html @@ -1 +1 @@ -RunFunction | libp2p

                                                                                                                                                                    Interface RunFunction<Options, ReturnType>

                                                                                                                                                                    interface RunFunction<Options, ReturnType> ((opts?) => Promise<ReturnType>)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file +RunFunction | libp2p

                                                                                                                                                                    Interface RunFunction<Options, ReturnType>

                                                                                                                                                                    interface RunFunction<Options, ReturnType> ((opts?) => Promise<ReturnType>)

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html b/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html index 6030e41424..60f0984167 100644 --- a/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html +++ b/interfaces/_libp2p_utils.rate_limiter.GetKeySecDurationOptions.html @@ -1,2 +1,2 @@ -GetKeySecDurationOptions | libp2p

                                                                                                                                                                    Interface GetKeySecDurationOptions

                                                                                                                                                                    interface GetKeySecDurationOptions {
                                                                                                                                                                        customDuration?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    customDuration? -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional customDuration

                                                                                                                                                                    customDuration?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    customDuration
                                                                                                                                                                    \ No newline at end of file +GetKeySecDurationOptions | libp2p

                                                                                                                                                                    Interface GetKeySecDurationOptions

                                                                                                                                                                    interface GetKeySecDurationOptions {
                                                                                                                                                                        customDuration?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    customDuration? +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional customDuration

                                                                                                                                                                    customDuration?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    customDuration
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html b/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html index d3abc39c52..4c1420e109 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateLimiterInit.html @@ -1,4 +1,4 @@ -RateLimiterInit | libp2p

                                                                                                                                                                    Interface RateLimiterInit

                                                                                                                                                                    interface RateLimiterInit {
                                                                                                                                                                        blockDuration?: number;
                                                                                                                                                                        duration?: number;
                                                                                                                                                                        execEvenly?: boolean;
                                                                                                                                                                        execEvenlyMinDelayMs?: number;
                                                                                                                                                                        keyPrefix?: string;
                                                                                                                                                                        points?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    blockDuration? +RateLimiterInit | libp2p

                                                                                                                                                                    Interface RateLimiterInit

                                                                                                                                                                    interface RateLimiterInit {
                                                                                                                                                                        blockDuration?: number;
                                                                                                                                                                        duration?: number;
                                                                                                                                                                        execEvenly?: boolean;
                                                                                                                                                                        execEvenlyMinDelayMs?: number;
                                                                                                                                                                        keyPrefix?: string;
                                                                                                                                                                        points?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    blockDuration? duration? execEvenly? execEvenlyMinDelayMs? @@ -7,18 +7,18 @@

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional blockDuration

                                                                                                                                                                    blockDuration?: number

                                                                                                                                                                    Block if consumed more than points in current duration for blockDuration seconds

                                                                                                                                                                    Default

                                                                                                                                                                    0
                                                                                                                                                                    -

                                                                                                                                                                    Optional duration

                                                                                                                                                                    duration?: number

                                                                                                                                                                    Per seconds

                                                                                                                                                                    +

                                                                                                                                                                    Optional duration

                                                                                                                                                                    duration?: number

                                                                                                                                                                    Per seconds

                                                                                                                                                                    Default

                                                                                                                                                                    1
                                                                                                                                                                    -

                                                                                                                                                                    Optional execEvenly

                                                                                                                                                                    execEvenly?: boolean

                                                                                                                                                                    Execute allowed actions evenly over duration

                                                                                                                                                                    +

                                                                                                                                                                    Optional execEvenly

                                                                                                                                                                    execEvenly?: boolean

                                                                                                                                                                    Execute allowed actions evenly over duration

                                                                                                                                                                    Default

                                                                                                                                                                    false
                                                                                                                                                                    -

                                                                                                                                                                    Optional execEvenlyMinDelayMs

                                                                                                                                                                    execEvenlyMinDelayMs?: number

                                                                                                                                                                    ms, works with execEvenly=true option

                                                                                                                                                                    +

                                                                                                                                                                    Optional execEvenlyMinDelayMs

                                                                                                                                                                    execEvenlyMinDelayMs?: number

                                                                                                                                                                    ms, works with execEvenly=true option

                                                                                                                                                                    Default

                                                                                                                                                                    duration * 1000 / points
                                                                                                                                                                    -

                                                                                                                                                                    Optional keyPrefix

                                                                                                                                                                    keyPrefix?: string

                                                                                                                                                                    Default

                                                                                                                                                                    rlflx
+

                                                                                                                                                                    Optional keyPrefix

                                                                                                                                                                    keyPrefix?: string

                                                                                                                                                                    Default

                                                                                                                                                                    rlflx
                                                                                                                                                                    -

                                                                                                                                                                    Optional points

                                                                                                                                                                    points?: number

                                                                                                                                                                    Number of points

                                                                                                                                                                    +

                                                                                                                                                                    Optional points

                                                                                                                                                                    points?: number

                                                                                                                                                                    Number of points

                                                                                                                                                                    Default

                                                                                                                                                                    4
                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    blockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixpoints
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    blockDurationdurationexecEvenlyexecEvenlyMinDelayMskeyPrefixpoints
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html b/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html index fbf7a4078d..703fbda298 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateLimiterResult.html @@ -1,5 +1,5 @@ -RateLimiterResult | libp2p

                                                                                                                                                                    Interface RateLimiterResult

                                                                                                                                                                    interface RateLimiterResult {
                                                                                                                                                                        consumedPoints: number;
                                                                                                                                                                        isFirstInDuration: boolean;
                                                                                                                                                                        msBeforeNext: number;
                                                                                                                                                                        remainingPoints: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    consumedPoints +RateLimiterResult | libp2p

                                                                                                                                                                    Interface RateLimiterResult

                                                                                                                                                                    interface RateLimiterResult {
                                                                                                                                                                        consumedPoints: number;
                                                                                                                                                                        isFirstInDuration: boolean;
                                                                                                                                                                        msBeforeNext: number;
                                                                                                                                                                        remainingPoints: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    consumedPoints isFirstInDuration msBeforeNext remainingPoints -

                                                                                                                                                                    Properties

                                                                                                                                                                    consumedPoints

                                                                                                                                                                    consumedPoints: number

                                                                                                                                                                    isFirstInDuration

                                                                                                                                                                    isFirstInDuration: boolean

                                                                                                                                                                    msBeforeNext

                                                                                                                                                                    msBeforeNext: number

                                                                                                                                                                    remainingPoints

                                                                                                                                                                    remainingPoints: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    consumedPointsisFirstInDurationmsBeforeNextremainingPoints
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    consumedPoints

                                                                                                                                                                    consumedPoints: number

                                                                                                                                                                    isFirstInDuration

                                                                                                                                                                    isFirstInDuration: boolean

                                                                                                                                                                    msBeforeNext

                                                                                                                                                                    msBeforeNext: number

                                                                                                                                                                    remainingPoints

                                                                                                                                                                    remainingPoints: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    consumedPointsisFirstInDurationmsBeforeNextremainingPoints
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.rate_limiter.RateRecord.html b/interfaces/_libp2p_utils.rate_limiter.RateRecord.html index 9f61cf00a3..ba5fa47959 100644 --- a/interfaces/_libp2p_utils.rate_limiter.RateRecord.html +++ b/interfaces/_libp2p_utils.rate_limiter.RateRecord.html @@ -1,4 +1,4 @@ -RateRecord | libp2p

                                                                                                                                                                    Interface RateRecord

                                                                                                                                                                    interface RateRecord {
                                                                                                                                                                        expiresAt?: Date;
                                                                                                                                                                        timeoutId?: Timeout;
                                                                                                                                                                        value: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    expiresAt? +RateRecord | libp2p

                                                                                                                                                                    Interface RateRecord

                                                                                                                                                                    interface RateRecord {
                                                                                                                                                                        expiresAt?: Date;
                                                                                                                                                                        timeoutId?: Timeout;
                                                                                                                                                                        value: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    expiresAt? timeoutId? value -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional expiresAt

                                                                                                                                                                    expiresAt?: Date

                                                                                                                                                                    Optional timeoutId

                                                                                                                                                                    timeoutId?: Timeout

                                                                                                                                                                    value

                                                                                                                                                                    value: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    expiresAttimeoutIdvalue
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional expiresAt

                                                                                                                                                                    expiresAt?: Date

                                                                                                                                                                    Optional timeoutId

                                                                                                                                                                    timeoutId?: Timeout

                                                                                                                                                                    value

                                                                                                                                                                    value: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    expiresAttimeoutIdvalue
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html b/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html index 6b1232548c..b1c62725e7 100644 --- a/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html +++ b/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html @@ -1,5 +1,5 @@ -StreamProperties | libp2p

                                                                                                                                                                    Interface StreamProperties

                                                                                                                                                                    interface StreamProperties {
                                                                                                                                                                        localAddr: Multiaddr;
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        remoteAddr: Multiaddr;
                                                                                                                                                                        stream: Stream;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    localAddr +StreamProperties | libp2p

                                                                                                                                                                    Interface StreamProperties

                                                                                                                                                                    interface StreamProperties {
                                                                                                                                                                        localAddr: Multiaddr;
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        remoteAddr: Multiaddr;
                                                                                                                                                                        stream: Stream;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    localAddr logger remoteAddr stream -

                                                                                                                                                                    Properties

                                                                                                                                                                    localAddr

                                                                                                                                                                    localAddr: Multiaddr

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    remoteAddr

                                                                                                                                                                    remoteAddr: Multiaddr

                                                                                                                                                                    stream

                                                                                                                                                                    stream: Stream

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    localAddrloggerremoteAddrstream
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    localAddr

                                                                                                                                                                    localAddr: Multiaddr

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    remoteAddr

                                                                                                                                                                    remoteAddr: Multiaddr

                                                                                                                                                                    stream

                                                                                                                                                                    stream: Stream

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    localAddrloggerremoteAddrstream
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html b/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html index 6211525863..ff9b6cc7c8 100644 --- a/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html +++ b/interfaces/_libp2p_utils.tracked_list.CreateTrackedListInit.html @@ -1,5 +1,5 @@ -CreateTrackedListInit | libp2p

                                                                                                                                                                    Interface CreateTrackedListInit

                                                                                                                                                                    interface CreateTrackedListInit {
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics? +CreateTrackedListInit | libp2p

                                                                                                                                                                    Interface CreateTrackedListInit

                                                                                                                                                                    interface CreateTrackedListInit {
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics? name

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    A metrics implementation

                                                                                                                                                                    -

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    The metric name to use

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    The metric name to use

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html b/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html index 752fd765a7..7c1432f0bc 100644 --- a/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html +++ b/interfaces/_libp2p_utils.tracked_map.CreateTrackedMapInit.html @@ -1,5 +1,5 @@ -CreateTrackedMapInit | libp2p

                                                                                                                                                                    Interface CreateTrackedMapInit

                                                                                                                                                                    interface CreateTrackedMapInit {
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics? +CreateTrackedMapInit | libp2p

                                                                                                                                                                    Interface CreateTrackedMapInit

                                                                                                                                                                    interface CreateTrackedMapInit {
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics? name

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    A metrics implementation

                                                                                                                                                                    -

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    The metric name to use

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    The metric name to use

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html b/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html index a9dc2bc40f..06cfa6c819 100644 --- a/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html +++ b/interfaces/_libp2p_utils.tracked_map.TrackedMapInit.html @@ -1,3 +1,3 @@ -TrackedMapInit | libp2p

                                                                                                                                                                    Interface TrackedMapInit

                                                                                                                                                                    interface TrackedMapInit {
                                                                                                                                                                        metrics: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics +TrackedMapInit | libp2p

                                                                                                                                                                    Interface TrackedMapInit

                                                                                                                                                                    interface TrackedMapInit {
                                                                                                                                                                        metrics: Metrics;
                                                                                                                                                                        name: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics name -

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics

                                                                                                                                                                    metrics: Metrics

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    metrics

                                                                                                                                                                    metrics: Metrics

                                                                                                                                                                    name

                                                                                                                                                                    name: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    metricsname
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_webrtc.DataChannelOptions.html b/interfaces/_libp2p_webrtc.DataChannelOptions.html index bbad01b989..0dfe11ccf8 100644 --- a/interfaces/_libp2p_webrtc.DataChannelOptions.html +++ b/interfaces/_libp2p_webrtc.DataChannelOptions.html @@ -1,4 +1,4 @@ -DataChannelOptions | libp2p

                                                                                                                                                                    Interface DataChannelOptions

                                                                                                                                                                    interface DataChannelOptions {
                                                                                                                                                                        bufferedAmountLowEventTimeout?: number;
                                                                                                                                                                        closeTimeout?: number;
                                                                                                                                                                        drainTimeout?: number;
                                                                                                                                                                        maxBufferedAmount?: number;
                                                                                                                                                                        maxMessageSize?: number;
                                                                                                                                                                        openTimeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    bufferedAmountLowEventTimeout? +DataChannelOptions | libp2p

                                                                                                                                                                    Interface DataChannelOptions

                                                                                                                                                                    interface DataChannelOptions {
                                                                                                                                                                        bufferedAmountLowEventTimeout?: number;
                                                                                                                                                                        closeTimeout?: number;
                                                                                                                                                                        drainTimeout?: number;
                                                                                                                                                                        maxBufferedAmount?: number;
                                                                                                                                                                        maxMessageSize?: number;
                                                                                                                                                                        openTimeout?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    bufferedAmountLowEventTimeout? closeTimeout? drainTimeout? maxBufferedAmount? @@ -7,15 +7,15 @@

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional bufferedAmountLowEventTimeout

                                                                                                                                                                    bufferedAmountLowEventTimeout?: number

                                                                                                                                                                    When bufferedAmount is above maxBufferedAmount, we pause sending until the bufferedAmountLow event fires - this controls how long we wait for that event in ms (default: 30s)

                                                                                                                                                                    -

                                                                                                                                                                    Optional closeTimeout

                                                                                                                                                                    closeTimeout?: number

                                                                                                                                                                    When closing a stream we first send a FIN flag to the remote and wait +

                                                                                                                                                                    Optional closeTimeout

                                                                                                                                                                    closeTimeout?: number

                                                                                                                                                                    When closing a stream we first send a FIN flag to the remote and wait for a FIN_ACK reply before closing the underlying RTCDataChannel - this controls how long we wait for the acknowledgement in ms (default: 5s)

                                                                                                                                                                    -

                                                                                                                                                                    Optional drainTimeout

                                                                                                                                                                    drainTimeout?: number

                                                                                                                                                                    When closing a stream, we wait for bufferedAmount to become 0 before +

                                                                                                                                                                    Optional drainTimeout

                                                                                                                                                                    drainTimeout?: number

                                                                                                                                                                    When closing a stream, we wait for bufferedAmount to become 0 before closing the underlying RTCDataChannel - this controls how long we wait in ms (default: 30s)

                                                                                                                                                                    -

                                                                                                                                                                    Optional maxBufferedAmount

                                                                                                                                                                    maxBufferedAmount?: number

                                                                                                                                                                    If the channel's bufferedAmount grows over this amount in bytes, wait +

                                                                                                                                                                    Optional maxBufferedAmount

                                                                                                                                                                    maxBufferedAmount?: number

                                                                                                                                                                    If the channel's bufferedAmount grows over this amount in bytes, wait for it to drain before sending more data (default: 16MB)

                                                                                                                                                                    -

                                                                                                                                                                    Optional maxMessageSize

                                                                                                                                                                    maxMessageSize?: number

                                                                                                                                                                    The maximum message size sendable over the channel in bytes (default 16KB)

                                                                                                                                                                    -

                                                                                                                                                                    Optional openTimeout

                                                                                                                                                                    openTimeout?: number

                                                                                                                                                                    When sending the first data message, if the channel is not in the "open" +

                                                                                                                                                                    Optional maxMessageSize

                                                                                                                                                                    maxMessageSize?: number

                                                                                                                                                                    The maximum message size sendable over the channel in bytes (default 16KB)

                                                                                                                                                                    +

                                                                                                                                                                    Optional openTimeout

                                                                                                                                                                    openTimeout?: number

                                                                                                                                                                    When sending the first data message, if the channel is not in the "open" state, wait this long for the "open" event to fire.

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bufferedAmountLowEventTimeoutcloseTimeoutdrainTimeoutmaxBufferedAmountmaxMessageSizeopenTimeout
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    bufferedAmountLowEventTimeoutcloseTimeoutdrainTimeoutmaxBufferedAmountmaxMessageSizeopenTimeout
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsComponents.html b/interfaces/_libp2p_websockets.index.WebSocketsComponents.html index 72ee612af7..bdf2af1f74 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsComponents.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsComponents.html @@ -1,3 +1,3 @@ -WebSocketsComponents | libp2p

                                                                                                                                                                    Interface WebSocketsComponents

                                                                                                                                                                    interface WebSocketsComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger +WebSocketsComponents | libp2p

                                                                                                                                                                    Interface WebSocketsComponents

                                                                                                                                                                    interface WebSocketsComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger metrics? -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetrics
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetrics
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsInit.html b/interfaces/_libp2p_websockets.index.WebSocketsInit.html index 03cc209c78..408627c4a4 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsInit.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsInit.html @@ -2,9 +2,9 @@ the optional signal property.

                                                                                                                                                                    Example

                                                                                                                                                                    const controller = new AbortController()

                                                                                                                                                                    aLongRunningOperation({
                                                                                                                                                                      signal: controller.signal
                                                                                                                                                                    })

                                                                                                                                                                    // later

                                                                                                                                                                    controller.abort()
                                                                                                                                                                    -
                                                                                                                                                                    interface WebSocketsInit {
                                                                                                                                                                        closeOnEnd?: boolean;
                                                                                                                                                                        filter?: MultiaddrFilter;
                                                                                                                                                                        server?: Server<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        websocket?: ClientOptions;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    closeOnEnd? +
                                                                                                                                                                    interface WebSocketsInit {
                                                                                                                                                                        closeOnEnd?: boolean;
                                                                                                                                                                        filter?: MultiaddrFilter;
                                                                                                                                                                        server?: Server<typeof IncomingMessage, typeof ServerResponse>;
                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                        websocket?: ClientOptions;
                                                                                                                                                                    }

                                                                                                                                                                    Hierarchy (view full)

                                                                                                                                                                    Properties

                                                                                                                                                                    closeOnEnd? filter? server? signal? websocket? -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional closeOnEnd

                                                                                                                                                                    closeOnEnd?: boolean

                                                                                                                                                                    Optional filter

                                                                                                                                                                    filter?: MultiaddrFilter

                                                                                                                                                                    Optional server

                                                                                                                                                                    server?: Server<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Optional websocket

                                                                                                                                                                    websocket?: ClientOptions

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closeOnEndfilterserversignalwebsocket
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional closeOnEnd

                                                                                                                                                                    closeOnEnd?: boolean

                                                                                                                                                                    Optional filter

                                                                                                                                                                    filter?: MultiaddrFilter

                                                                                                                                                                    Optional server

                                                                                                                                                                    server?: Server<typeof IncomingMessage, typeof ServerResponse>

                                                                                                                                                                    Optional signal

                                                                                                                                                                    signal?: AbortSignal

                                                                                                                                                                    Optional websocket

                                                                                                                                                                    websocket?: ClientOptions

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    closeOnEndfilterserversignalwebsocket
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html b/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html index dd845aaf83..e1244b2efd 100644 --- a/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html +++ b/interfaces/_libp2p_websockets.index.WebSocketsMetrics.html @@ -1,2 +1,2 @@ -WebSocketsMetrics | libp2p

                                                                                                                                                                    Interface WebSocketsMetrics

                                                                                                                                                                    interface WebSocketsMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents -

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file +WebSocketsMetrics | libp2p

                                                                                                                                                                    Interface WebSocketsMetrics

                                                                                                                                                                    interface WebSocketsMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents +

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportCertificate.html b/interfaces/_libp2p_webtransport.WebTransportCertificate.html index 4891ae48ab..d099abfea8 100644 --- a/interfaces/_libp2p_webtransport.WebTransportCertificate.html +++ b/interfaces/_libp2p_webtransport.WebTransportCertificate.html @@ -1,6 +1,6 @@ WebTransportCertificate | libp2p

                                                                                                                                                                    Interface WebTransportCertificate

                                                                                                                                                                    PEM format server certificate and private key

                                                                                                                                                                    -
                                                                                                                                                                    interface WebTransportCertificate {
                                                                                                                                                                        hash: MultihashDigest<number>;
                                                                                                                                                                        pem: string;
                                                                                                                                                                        privateKey: string;
                                                                                                                                                                        secret: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    hash +
                                                                                                                                                                    interface WebTransportCertificate {
                                                                                                                                                                        hash: MultihashDigest<number>;
                                                                                                                                                                        pem: string;
                                                                                                                                                                        privateKey: string;
                                                                                                                                                                        secret: string;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    hash pem privateKey secret -

                                                                                                                                                                    Properties

                                                                                                                                                                    hash

                                                                                                                                                                    hash: MultihashDigest<number>

                                                                                                                                                                    pem

                                                                                                                                                                    pem: string

                                                                                                                                                                    privateKey

                                                                                                                                                                    privateKey: string

                                                                                                                                                                    secret

                                                                                                                                                                    secret: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    hashpemprivateKeysecret
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    hash

                                                                                                                                                                    hash: MultihashDigest<number>

                                                                                                                                                                    pem

                                                                                                                                                                    pem: string

                                                                                                                                                                    privateKey

                                                                                                                                                                    privateKey: string

                                                                                                                                                                    secret

                                                                                                                                                                    secret: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    hashpemprivateKeysecret
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportComponents.html b/interfaces/_libp2p_webtransport.WebTransportComponents.html index e78c96a8c8..741b619710 100644 --- a/interfaces/_libp2p_webtransport.WebTransportComponents.html +++ b/interfaces/_libp2p_webtransport.WebTransportComponents.html @@ -1,4 +1,4 @@ -WebTransportComponents | libp2p

                                                                                                                                                                    Interface WebTransportComponents

                                                                                                                                                                    interface WebTransportComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger +WebTransportComponents | libp2p

                                                                                                                                                                    Interface WebTransportComponents

                                                                                                                                                                    interface WebTransportComponents {
                                                                                                                                                                        logger: ComponentLogger;
                                                                                                                                                                        metrics?: Metrics;
                                                                                                                                                                        peerId: PeerId;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    logger metrics? peerId -

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetricspeerId
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    logger

                                                                                                                                                                    logger: ComponentLogger

                                                                                                                                                                    Optional metrics

                                                                                                                                                                    metrics?: Metrics

                                                                                                                                                                    peerId

                                                                                                                                                                    peerId: PeerId

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    loggermetricspeerId
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportInit.html b/interfaces/_libp2p_webtransport.WebTransportInit.html index 64cb8d00cc..b190780fb8 100644 --- a/interfaces/_libp2p_webtransport.WebTransportInit.html +++ b/interfaces/_libp2p_webtransport.WebTransportInit.html @@ -1,3 +1,3 @@ -WebTransportInit | libp2p

                                                                                                                                                                    Interface WebTransportInit

                                                                                                                                                                    interface WebTransportInit {
                                                                                                                                                                        certificates?: WebTransportCertificate[];
                                                                                                                                                                        maxInboundStreams?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    certificates? +WebTransportInit | libp2p

                                                                                                                                                                    Interface WebTransportInit

                                                                                                                                                                    interface WebTransportInit {
                                                                                                                                                                        certificates?: WebTransportCertificate[];
                                                                                                                                                                        maxInboundStreams?: number;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    certificates? maxInboundStreams? -

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional certificates

                                                                                                                                                                    certificates?: WebTransportCertificate[]

                                                                                                                                                                    Optional maxInboundStreams

                                                                                                                                                                    maxInboundStreams?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    certificatesmaxInboundStreams
                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional certificates

                                                                                                                                                                    certificates?: WebTransportCertificate[]

                                                                                                                                                                    Optional maxInboundStreams

                                                                                                                                                                    maxInboundStreams?: number

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    certificatesmaxInboundStreams
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/_libp2p_webtransport.WebTransportMetrics.html b/interfaces/_libp2p_webtransport.WebTransportMetrics.html index 0bc3b28068..ccfb763ace 100644 --- a/interfaces/_libp2p_webtransport.WebTransportMetrics.html +++ b/interfaces/_libp2p_webtransport.WebTransportMetrics.html @@ -1,2 +1,2 @@ -WebTransportMetrics | libp2p

                                                                                                                                                                    Interface WebTransportMetrics

                                                                                                                                                                    interface WebTransportMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents -

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file +WebTransportMetrics | libp2p

                                                                                                                                                                    Interface WebTransportMetrics

                                                                                                                                                                    interface WebTransportMetrics {
                                                                                                                                                                        dialerEvents: CounterGroup;
                                                                                                                                                                    }

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents +

                                                                                                                                                                    Properties

                                                                                                                                                                    dialerEvents

                                                                                                                                                                    dialerEvents: CounterGroup

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    On This Page

                                                                                                                                                                    dialerEvents
                                                                                                                                                                    \ No newline at end of file diff --git a/interfaces/libp2p.index.Libp2pInit.html b/interfaces/libp2p.index.Libp2pInit.html index 501a90ee43..8905d5a493 100644 --- a/interfaces/libp2p.index.Libp2pInit.html +++ b/interfaces/libp2p.index.Libp2pInit.html @@ -1,5 +1,5 @@ Libp2pInit | libp2p

                                                                                                                                                                    Interface Libp2pInit<T>

                                                                                                                                                                    For Libp2p configurations and modules details read the Configuration Document.

                                                                                                                                                                    -
                                                                                                                                                                    interface Libp2pInit<T> {
                                                                                                                                                                        addresses?: AddressManagerInit;
                                                                                                                                                                        connectionEncryption?: ((components) => ConnectionEncrypter<unknown>)[];
                                                                                                                                                                        connectionGater?: ConnectionGater;
                                                                                                                                                                        connectionManager?: ConnectionManagerInit;
                                                                                                                                                                        connectionMonitor?: ConnectionMonitorInit;
                                                                                                                                                                        contentRouters?: ((components) => ContentRouting)[];
                                                                                                                                                                        datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                        dns?: DNS;
                                                                                                                                                                        logger?: ComponentLogger;
                                                                                                                                                                        nodeInfo?: NodeInfo;
                                                                                                                                                                        peerDiscovery?: ((components) => PeerDiscovery)[];
                                                                                                                                                                        peerId?: PeerId;
                                                                                                                                                                        peerRouters?: ((components) => PeerRouting)[];
                                                                                                                                                                        peerStore?: PersistentPeerStoreInit;
                                                                                                                                                                        privateKey?: PrivateKey<"Ed25519">;
                                                                                                                                                                        services?: ServiceFactoryMap<T>;
                                                                                                                                                                        streamMuxers?: ((components) => StreamMuxerFactory)[];
                                                                                                                                                                        transportManager?: TransportManagerInit;
                                                                                                                                                                        transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[];
                                                                                                                                                                        connectionProtector?(components): ConnectionProtector;
                                                                                                                                                                        metrics?(components): Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    addresses? +
                                                                                                                                                                    interface Libp2pInit<T> {
                                                                                                                                                                        addresses?: AddressManagerInit;
                                                                                                                                                                        connectionEncryption?: ((components) => ConnectionEncrypter<unknown>)[];
                                                                                                                                                                        connectionGater?: ConnectionGater;
                                                                                                                                                                        connectionManager?: ConnectionManagerInit;
                                                                                                                                                                        connectionMonitor?: ConnectionMonitorInit;
                                                                                                                                                                        contentRouters?: ((components) => ContentRouting)[];
                                                                                                                                                                        datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                        dns?: DNS;
                                                                                                                                                                        logger?: ComponentLogger;
                                                                                                                                                                        nodeInfo?: NodeInfo;
                                                                                                                                                                        peerDiscovery?: ((components) => PeerDiscovery)[];
                                                                                                                                                                        peerId?: PeerId;
                                                                                                                                                                        peerRouters?: ((components) => PeerRouting)[];
                                                                                                                                                                        peerStore?: PersistentPeerStoreInit;
                                                                                                                                                                        privateKey?: PrivateKey<"Ed25519">;
                                                                                                                                                                        services?: ServiceFactoryMap<T>;
                                                                                                                                                                        streamMuxers?: ((components) => StreamMuxerFactory)[];
                                                                                                                                                                        transportManager?: TransportManagerInit;
                                                                                                                                                                        transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[];
                                                                                                                                                                        connectionProtector?(components): ConnectionProtector;
                                                                                                                                                                        metrics?(components): Metrics;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    Properties

                                                                                                                                                                    addresses? connectionEncryption? connectionGater? connectionManager? @@ -21,15 +21,15 @@

                                                                                                                                                                    Methods

                                                                                                                                                                    connectionProtector? metrics?

                                                                                                                                                                    Properties

                                                                                                                                                                    Optional addresses

                                                                                                                                                                    addresses?: AddressManagerInit

                                                                                                                                                                    Addresses for transport listening and to advertise to the network

                                                                                                                                                                    -

                                                                                                                                                                    Optional connectionEncryption

                                                                                                                                                                    connectionEncryption?: ((components) => ConnectionEncrypter<unknown>)[]

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional connectionGater

                                                                                                                                                                    connectionGater?: ConnectionGater

                                                                                                                                                                    A connection gater can deny new connections based on user criteria

                                                                                                                                                                    -

                                                                                                                                                                    Optional connectionManager

                                                                                                                                                                    connectionManager?: ConnectionManagerInit

                                                                                                                                                                    libp2p Connection Manager configuration

                                                                                                                                                                    -

                                                                                                                                                                    Optional connectionMonitor

                                                                                                                                                                    connectionMonitor?: ConnectionMonitorInit

                                                                                                                                                                    libp2p Connection Monitor configuration

                                                                                                                                                                    -

                                                                                                                                                                    Optional contentRouters

                                                                                                                                                                    contentRouters?: ((components) => ContentRouting)[]

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional datastore

                                                                                                                                                                    datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                    An optional datastore to persist peer information, DHT records, etc.

                                                                                                                                                                    +

                                                                                                                                                                    Optional connectionEncryption

                                                                                                                                                                    connectionEncryption?: ((components) => ConnectionEncrypter<unknown>)[]

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional connectionGater

                                                                                                                                                                    connectionGater?: ConnectionGater

                                                                                                                                                                    A connection gater can deny new connections based on user criteria

                                                                                                                                                                    +

                                                                                                                                                                    Optional connectionManager

                                                                                                                                                                    connectionManager?: ConnectionManagerInit

                                                                                                                                                                    libp2p Connection Manager configuration

                                                                                                                                                                    +

                                                                                                                                                                    Optional connectionMonitor

                                                                                                                                                                    connectionMonitor?: ConnectionMonitorInit

                                                                                                                                                                    libp2p Connection Monitor configuration

                                                                                                                                                                    +

                                                                                                                                                                    Optional contentRouters

                                                                                                                                                                    contentRouters?: ((components) => ContentRouting)[]

                                                                                                                                                                    Type declaration

                                                                                                                                                                    Optional datastore

                                                                                                                                                                    datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                    An optional datastore to persist peer information, DHT records, etc.

                                                                                                                                                                    An in-memory datastore will be used if one is not provided.

                                                                                                                                                                    -

                                                                                                                                                                    Type declaration

                                                                                                                                                                      Type declaration

                                                                                                                                                                        Type declaration

                                                                                                                                                                          Type declaration

                                                                                                                                                                            Type declaration

                                                                                                                                                                              Type declaration

                                                                                                                                                                                Type declaration

                                                                                                                                                                                  Type declaration

                                                                                                                                                                                    Type declaration

                                                                                                                                                                                      Type declaration

                                                                                                                                                                                        Optional dns

                                                                                                                                                                                        dns?: DNS

                                                                                                                                                                                        An optional DNS resolver configuration. If omitted the default DNS resolver +

                                                                                                                                                                                        Type declaration

                                                                                                                                                                                          Type declaration

                                                                                                                                                                                            Type declaration

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                            Optional dns

                                                                                                                                                                                                            dns?: DNS

                                                                                                                                                                                                            An optional DNS resolver configuration. If omitted the default DNS resolver for the platform will be used which means node:dns on Node.js and DNS-JSON-over-HTTPS for browsers using Google and Cloudflare servers.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional logger

                                                                                                                                                                                                            logger?: ComponentLogger

                                                                                                                                                                                                            An optional logging implementation that can be used to write runtime logs.

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional logger

                                                                                                                                                                                                            logger?: ComponentLogger

                                                                                                                                                                                                            An optional logging implementation that can be used to write runtime logs.

                                                                                                                                                                                                            Set the DEBUG env var or the debug key on LocalStorage to see logs.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            Node.js:

                                                                                                                                                                                                            $ DEBUG="*libp2p:*" node myscript.js
@@ -37,13 +37,13 @@
 
                                                                                                                                                                                                            Browsers:
                                                                                                                                                                                                            
 
                                                                                                                                                                                                            localStorage.setItem('debug', '*libp2p:*')
 
                                                                                                                                                                                                            
-

                                                                                                                                                                                                            Optional nodeInfo

                                                                                                                                                                                                            nodeInfo?: NodeInfo

                                                                                                                                                                                                            Metadata about the node - implementation name, version number, etc

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional peerDiscovery

                                                                                                                                                                                                            peerDiscovery?: ((components) => PeerDiscovery)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional peerId

                                                                                                                                                                                                            peerId?: PeerId

                                                                                                                                                                                                            peerId instance (it will be created if not provided)

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional peerRouters

                                                                                                                                                                                                            peerRouters?: ((components) => PeerRouting)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional peerStore

                                                                                                                                                                                                            peerStore?: PersistentPeerStoreInit

                                                                                                                                                                                                            libp2p PeerStore configuration

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional privateKey

                                                                                                                                                                                                            privateKey?: PrivateKey<"Ed25519">

                                                                                                                                                                                                            Private key associated with the peerId

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional services

                                                                                                                                                                                                            services?: ServiceFactoryMap<T>

                                                                                                                                                                                                            Arbitrary libp2p modules

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional streamMuxers

                                                                                                                                                                                                            streamMuxers?: ((components) => StreamMuxerFactory)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional transportManager

                                                                                                                                                                                                            transportManager?: TransportManagerInit

                                                                                                                                                                                                            libp2p transport manager configuration

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Optional transports

                                                                                                                                                                                                            transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[]

                                                                                                                                                                                                            An array that must include at least 1 compliant transport

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Methods

                                                                                                                                                                                                            Optional connectionProtector

                                                                                                                                                                                                            Optional metrics

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            addressesconnectionEncryptionconnectionGaterconnectionManagerconnectionMonitorcontentRoutersdatastorednsloggernodeInfopeerDiscoverypeerIdpeerRouterspeerStoreprivateKeyservicesstreamMuxerstransportManagertransportsconnectionProtectormetrics
                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Optional nodeInfo

                                                                                                                                                                                                            nodeInfo?: NodeInfo

                                                                                                                                                                                                            Metadata about the node - implementation name, version number, etc

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional peerDiscovery

                                                                                                                                                                                                            peerDiscovery?: ((components) => PeerDiscovery)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional peerId

                                                                                                                                                                                                            peerId?: PeerId

                                                                                                                                                                                                            peerId instance (it will be created if not provided)

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional peerRouters

                                                                                                                                                                                                            peerRouters?: ((components) => PeerRouting)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional peerStore

                                                                                                                                                                                                            peerStore?: PersistentPeerStoreInit

                                                                                                                                                                                                            libp2p PeerStore configuration

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional privateKey

                                                                                                                                                                                                            privateKey?: PrivateKey<"Ed25519">

                                                                                                                                                                                                            Private key associated with the peerId

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional services

                                                                                                                                                                                                            services?: ServiceFactoryMap<T>

                                                                                                                                                                                                            Arbitrary libp2p modules

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional streamMuxers

                                                                                                                                                                                                            streamMuxers?: ((components) => StreamMuxerFactory)[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Optional transportManager

                                                                                                                                                                                                            transportManager?: TransportManagerInit

                                                                                                                                                                                                            libp2p transport manager configuration

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Optional transports

                                                                                                                                                                                                            transports?: ((components) => Transport<ProgressEvent<any, unknown>>)[]

                                                                                                                                                                                                            An array that must include at least 1 compliant transport

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Methods

                                                                                                                                                                                                            Optional connectionProtector

                                                                                                                                                                                                            Optional metrics

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            addressesconnectionEncryptionconnectionGaterconnectionManagerconnectionMonitorcontentRoutersdatastorednsloggernodeInfopeerDiscoverypeerIdpeerRouterspeerStoreprivateKeyservicesstreamMuxerstransportManagertransportsconnectionProtectormetrics
                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_crypto.hmac.html b/modules/_libp2p_crypto.hmac.html index 4e1d655159..2916ec60ae 100644 --- a/modules/_libp2p_crypto.hmac.html +++ b/modules/_libp2p_crypto.hmac.html @@ -1,6 +1,6 @@ hmac | libp2p

                                                                                                                                                                                                            Module hmac

                                                                                                                                                                                                            Exposes an interface to the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198. An HMAC is a cryptographic hash that uses a key to sign a message. The receiver verifies the hash by recomputing it using the same key.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { create } from '@libp2p/hmac'

                                                                                                                                                                                                            const hash = 'SHA1' // 'SHA256' || 'SHA512'
                                                                                                                                                                                                            const hmac = await crypto.hmac.create(hash, uint8ArrayFromString('secret'))
                                                                                                                                                                                                            const sig = await hmac.digest(uint8ArrayFromString('hello world'))
                                                                                                                                                                                                            console.log(sig)
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            HMAC +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            HMAC

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            create

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_crypto.index.html b/modules/_libp2p_crypto.index.html index 48b00f914e..aa0e4d4811 100644 --- a/modules/_libp2p_crypto.index.html +++ b/modules/_libp2p_crypto.index.html @@ -1,7 +1,7 @@ index | libp2p

                                                                                                                                                                                                            Module index

                                                                                                                                                                                                            The libp2p-crypto library depends on the Web Crypto API in the browser. Web Crypto is available in all modern browsers, however browsers restrict its usage to Secure Contexts.

                                                                                                                                                                                                            This means you will not be able to use some @libp2p/crypto functions in the browser when the page is served over HTTP.

                                                                                                                                                                                                            To enable the Web Crypto API and allow @libp2p/crypto to work fully, please serve your page over HTTPS.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            References

                                                                                                                                                                                                            hmac +

                                                                                                                                                                                                            References

                                                                                                                                                                                                            hmac keys

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            pbkdf2 randomBytes diff --git a/modules/_libp2p_crypto.keys.html b/modules/_libp2p_crypto.keys.html index a394dc1059..bc24e1e29f 100644 --- a/modules/_libp2p_crypto.keys.html +++ b/modules/_libp2p_crypto.keys.html @@ -2,7 +2,7 @@

                                                                                                                                                                                                            The generateKeyPair, marshalPublicKey, and marshalPrivateKey functions accept a string type argument.

                                                                                                                                                                                                            Currently the 'RSA', 'ed25519', and secp256k1 types are supported, although ed25519 and secp256k1 keys support only signing and verification of messages.

                                                                                                                                                                                                            For encryption / decryption support, RSA keys should be used.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                            keysPBM +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                            keysPBM

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            Ed25519PrivateKey Ed25519PublicKey RsaPrivateKey diff --git a/modules/_libp2p_crypto.keys.keysPBM.KeyType.html b/modules/_libp2p_crypto.keys.keysPBM.KeyType.html index 5b72b1e36e..e03f67d650 100644 --- a/modules/_libp2p_crypto.keys.keysPBM.KeyType.html +++ b/modules/_libp2p_crypto.keys.keysPBM.KeyType.html @@ -1,2 +1,2 @@ -KeyType | libp2p

                                                                                                                                                                                                            Namespace KeyType

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec +KeyType | libp2p

                                                                                                                                                                                                            Namespace KeyType

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_crypto.keys.keysPBM.PrivateKey.html b/modules/_libp2p_crypto.keys.keysPBM.PrivateKey.html index 4326e10703..288b38862e 100644 --- a/modules/_libp2p_crypto.keys.keysPBM.PrivateKey.html +++ b/modules/_libp2p_crypto.keys.keysPBM.PrivateKey.html @@ -1,4 +1,4 @@ -PrivateKey | libp2p

                                                                                                                                                                                                            Namespace PrivateKey

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec +PrivateKey | libp2p

                                                                                                                                                                                                            Namespace PrivateKey

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec decode encode

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_crypto.keys.keysPBM.PublicKey.html b/modules/_libp2p_crypto.keys.keysPBM.PublicKey.html index 3180c1ad88..6e68afcd2a 100644 --- a/modules/_libp2p_crypto.keys.keysPBM.PublicKey.html +++ b/modules/_libp2p_crypto.keys.keysPBM.PublicKey.html @@ -1,4 +1,4 @@ -PublicKey | libp2p

                                                                                                                                                                                                            Namespace PublicKey

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec +PublicKey | libp2p

                                                                                                                                                                                                            Namespace PublicKey

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec decode encode

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_crypto.keys.keysPBM.html b/modules/_libp2p_crypto.keys.keysPBM.html index 7ac89955f1..a9d6b578db 100644 --- a/modules/_libp2p_crypto.keys.keysPBM.html +++ b/modules/_libp2p_crypto.keys.keysPBM.html @@ -1,4 +1,4 @@ -keysPBM | libp2p

                                                                                                                                                                                                            Namespace keysPBM

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                            KeyType +keysPBM | libp2p

                                                                                                                                                                                                            Namespace keysPBM

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                            KeyType PrivateKey PublicKey

                                                                                                                                                                                                            Enumerations

                                                                                                                                                                                                            KeyType diff --git a/modules/_libp2p_interface_compliance_tests.connection.html b/modules/_libp2p_interface_compliance_tests.connection.html index 388920595b..8870d7b870 100644 --- a/modules/_libp2p_interface_compliance_tests.connection.html +++ b/modules/_libp2p_interface_compliance_tests.connection.html @@ -1,2 +1,2 @@ -connection | libp2p

                                                                                                                                                                                                            Module connection

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default +connection | libp2p

                                                                                                                                                                                                            Module connection

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.connection_encryption.html b/modules/_libp2p_interface_compliance_tests.connection_encryption.html index 90bcd15bd7..26a92ca4c6 100644 --- a/modules/_libp2p_interface_compliance_tests.connection_encryption.html +++ b/modules/_libp2p_interface_compliance_tests.connection_encryption.html @@ -1,2 +1,2 @@ -connection-encryption | libp2p

                                                                                                                                                                                                            Module connection-encryption

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default +connection-encryption | libp2p

                                                                                                                                                                                                            Module connection-encryption

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.index.html b/modules/_libp2p_interface_compliance_tests.index.html index 2a89c1afb9..de09289b14 100644 --- a/modules/_libp2p_interface_compliance_tests.index.html +++ b/modules/_libp2p_interface_compliance_tests.index.html @@ -1,2 +1,2 @@ -index | libp2p

                                                                                                                                                                                                            Module index

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            TestSetup +index | libp2p

                                                                                                                                                                                                            Module index

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            TestSetup

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.is_valid_tick.html b/modules/_libp2p_interface_compliance_tests.is_valid_tick.html index ba5efaccc7..e5a11df475 100644 --- a/modules/_libp2p_interface_compliance_tests.is_valid_tick.html +++ b/modules/_libp2p_interface_compliance_tests.is_valid_tick.html @@ -1,2 +1,2 @@ -is-valid-tick | libp2p

                                                                                                                                                                                                            Module is-valid-tick

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isValidTick +is-valid-tick | libp2p

                                                                                                                                                                                                            Module is-valid-tick

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isValidTick

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.matchers.html b/modules/_libp2p_interface_compliance_tests.matchers.html index 5984fe555f..41f3b4e607 100644 --- a/modules/_libp2p_interface_compliance_tests.matchers.html +++ b/modules/_libp2p_interface_compliance_tests.matchers.html @@ -1,3 +1,3 @@ -matchers | libp2p

                                                                                                                                                                                                            Module matchers

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            matchMultiaddr +matchers | libp2p

                                                                                                                                                                                                            Module matchers

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            matchMultiaddr matchPeerId

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.mocks.html b/modules/_libp2p_interface_compliance_tests.mocks.html index 9c7ba5115c..6ddedff9dc 100644 --- a/modules/_libp2p_interface_compliance_tests.mocks.html +++ b/modules/_libp2p_interface_compliance_tests.mocks.html @@ -1,4 +1,4 @@ -mocks | libp2p

                                                                                                                                                                                                            Module mocks

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            MockNetworkComponents +mocks | libp2p

                                                                                                                                                                                                            Module mocks

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            MockNetworkComponents MockUpgraderInit

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            mockNetwork

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            connectionPair diff --git a/modules/_libp2p_interface_compliance_tests.peer_discovery.html b/modules/_libp2p_interface_compliance_tests.peer_discovery.html index 48a178bfed..35bbea4fe3 100644 --- a/modules/_libp2p_interface_compliance_tests.peer_discovery.html +++ b/modules/_libp2p_interface_compliance_tests.peer_discovery.html @@ -1,2 +1,2 @@ -peer-discovery | libp2p

                                                                                                                                                                                                            Module peer-discovery

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default +peer-discovery | libp2p

                                                                                                                                                                                                            Module peer-discovery

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.peers.html b/modules/_libp2p_interface_compliance_tests.peers.html index cac241e3be..c278f08daf 100644 --- a/modules/_libp2p_interface_compliance_tests.peers.html +++ b/modules/_libp2p_interface_compliance_tests.peers.html @@ -1,2 +1,2 @@ -peers | libp2p

                                                                                                                                                                                                            Module peers

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            default +peers | libp2p

                                                                                                                                                                                                            Module peers

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.pubsub.html b/modules/_libp2p_interface_compliance_tests.pubsub.html index d8f317d0c0..ec57a35b04 100644 --- a/modules/_libp2p_interface_compliance_tests.pubsub.html +++ b/modules/_libp2p_interface_compliance_tests.pubsub.html @@ -1,4 +1,4 @@ -pubsub | libp2p

                                                                                                                                                                                                            Module pubsub

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PubSubArgs +pubsub | libp2p

                                                                                                                                                                                                            Module pubsub

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PubSubArgs PubSubComponents

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.stream_muxer.html b/modules/_libp2p_interface_compliance_tests.stream_muxer.html index 50627c187c..48ba9a41c8 100644 --- a/modules/_libp2p_interface_compliance_tests.stream_muxer.html +++ b/modules/_libp2p_interface_compliance_tests.stream_muxer.html @@ -1,2 +1,2 @@ -stream-muxer | libp2p

                                                                                                                                                                                                            Module stream-muxer

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default +stream-muxer | libp2p

                                                                                                                                                                                                            Module stream-muxer

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_interface_compliance_tests.transport.html b/modules/_libp2p_interface_compliance_tests.transport.html index 9b7b22aae3..c9621d4836 100644 --- a/modules/_libp2p_interface_compliance_tests.transport.html +++ b/modules/_libp2p_interface_compliance_tests.transport.html @@ -1,4 +1,4 @@ -transport | libp2p

                                                                                                                                                                                                            Module transport

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            Connector +transport | libp2p

                                                                                                                                                                                                            Module transport

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            Connector TransportTestFixtures

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            default

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_kad_dht.MessageType.html b/modules/_libp2p_kad_dht.MessageType.html index baa3d45973..27ad246c90 100644 --- a/modules/_libp2p_kad_dht.MessageType.html +++ b/modules/_libp2p_kad_dht.MessageType.html @@ -1,3 +1,3 @@ MessageType | libp2p

                                                                                                                                                                                                            Namespace MessageType

                                                                                                                                                                                                            The types of messages sent to peers during DHT queries

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            codec

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_pubsub.errors.html b/modules/_libp2p_pubsub.errors.html index 759fb6b7be..ecc005280a 100644 --- a/modules/_libp2p_pubsub.errors.html +++ b/modules/_libp2p_pubsub.errors.html @@ -1,2 +1,2 @@ -errors | libp2p

                                                                                                                                                                                                            Module errors

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            codes +errors | libp2p

                                                                                                                                                                                                            Module errors

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            codes

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_pubsub.index.html b/modules/_libp2p_pubsub.index.html index dc45f0199b..052ec9902a 100644 --- a/modules/_libp2p_pubsub.index.html +++ b/modules/_libp2p_pubsub.index.html @@ -1,6 +1,6 @@ index | libp2p

                                                                                                                                                                                                            Module index

                                                                                                                                                                                                            A set of components to be extended in order to create a pubsub implementation.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { PubSubBaseProtocol } from '@libp2p/pubsub'
                                                                                                                                                                                                            import type { PubSubRPC, PublishResult, PubSubRPCMessage, PeerId, Message } from '@libp2p/interface'
                                                                                                                                                                                                            import type { Uint8ArrayList } from 'uint8arraylist'

                                                                                                                                                                                                            class MyPubsubImplementation extends PubSubBaseProtocol {
                                                                                                                                                                                                              decodeRpc (bytes: Uint8Array | Uint8ArrayList): PubSubRPC {
                                                                                                                                                                                                                throw new Error('Not implemented')
                                                                                                                                                                                                              }

                                                                                                                                                                                                              encodeRpc (rpc: PubSubRPC): Uint8Array {
                                                                                                                                                                                                                throw new Error('Not implemented')
                                                                                                                                                                                                              }

                                                                                                                                                                                                              encodeMessage (rpc: PubSubRPCMessage): Uint8Array {
                                                                                                                                                                                                                throw new Error('Not implemented')
                                                                                                                                                                                                              }

                                                                                                                                                                                                              async publishMessage (sender: PeerId, message: Message): Promise<PublishResult> {
                                                                                                                                                                                                                throw new Error('Not implemented')
                                                                                                                                                                                                              }
                                                                                                                                                                                                            }
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PubSubBaseProtocol +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PubSubBaseProtocol

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PubSubComponents

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_pubsub.peer_streams.html b/modules/_libp2p_pubsub.peer_streams.html index 9f651e67a2..7cd7c9eb00 100644 --- a/modules/_libp2p_pubsub.peer_streams.html +++ b/modules/_libp2p_pubsub.peer_streams.html @@ -1,4 +1,4 @@ -peer-streams | libp2p

                                                                                                                                                                                                            Module peer-streams

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PeerStreams +peer-streams | libp2p

                                                                                                                                                                                                            Module peer-streams

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PeerStreams

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PeerStreamsComponents PeerStreamsInit

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_pubsub.utils.html b/modules/_libp2p_pubsub.utils.html index 141bb8b190..6c3ad5f682 100644 --- a/modules/_libp2p_pubsub.utils.html +++ b/modules/_libp2p_pubsub.utils.html @@ -1,4 +1,4 @@ -utils | libp2p

                                                                                                                                                                                                            Module utils

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            anyMatch +utils | libp2p

                                                                                                                                                                                                            Module utils

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            anyMatch bigIntFromBytes bigIntToBytes ensureArray diff --git a/modules/_libp2p_utils.abort_options.html b/modules/_libp2p_utils.abort_options.html index c34308a9d7..0ad46e0220 100644 --- a/modules/_libp2p_utils.abort_options.html +++ b/modules/_libp2p_utils.abort_options.html @@ -1,2 +1,2 @@ -abort-options | libp2p

                                                                                                                                                                                                            Module abort-options

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            createTimeoutOptions +abort-options | libp2p

                                                                                                                                                                                                            Module abort-options

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            createTimeoutOptions

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.abstract_stream.html b/modules/_libp2p_utils.abstract_stream.html index f79fd17eb9..a82585e6bc 100644 --- a/modules/_libp2p_utils.abstract_stream.html +++ b/modules/_libp2p_utils.abstract_stream.html @@ -1,3 +1,3 @@ -abstract-stream | libp2p

                                                                                                                                                                                                            Module abstract-stream

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            AbstractStream +abstract-stream | libp2p

                                                                                                                                                                                                            Module abstract-stream

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            AbstractStream

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            AbstractStreamInit

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.adaptive_timeout.html b/modules/_libp2p_utils.adaptive_timeout.html index 273514b1d2..62a3fab2af 100644 --- a/modules/_libp2p_utils.adaptive_timeout.html +++ b/modules/_libp2p_utils.adaptive_timeout.html @@ -1,4 +1,4 @@ -adaptive-timeout | libp2p

                                                                                                                                                                                                            Module adaptive-timeout

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            AdaptiveTimeout +adaptive-timeout | libp2p

                                                                                                                                                                                                            Module adaptive-timeout

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            AdaptiveTimeout

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            AdaptiveTimeoutInit AdaptiveTimeoutSignal GetTimeoutSignalOptions diff --git a/modules/_libp2p_utils.address_sort.html b/modules/_libp2p_utils.address_sort.html index 23a351501a..efd48b5d35 100644 --- a/modules/_libp2p_utils.address_sort.html +++ b/modules/_libp2p_utils.address_sort.html @@ -1,7 +1,7 @@ address-sort | libp2p

                                                                                                                                                                                                            Module address-sort

                                                                                                                                                                                                            Provides strategies to sort a list of multiaddrs.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { publicAddressesFirst } from '@libp2p/utils/address-sort'
                                                                                                                                                                                                            import { multiaddr } from '@multformats/multiaddr'


                                                                                                                                                                                                            const addresses = [
                                                                                                                                                                                                              multiaddr('/ip4/127.0.0.1/tcp/9000'),
                                                                                                                                                                                                              multiaddr('/ip4/82.41.53.1/tcp/9000')
                                                                                                                                                                                                            ].sort(publicAddressesFirst)

                                                                                                                                                                                                            console.info(addresses)
                                                                                                                                                                                                            // ['/ip4/82.41.53.1/tcp/9000', '/ip4/127.0.0.1/tcp/9000']
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            certifiedAddressesFirst +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            certifiedAddressesFirst circuitRelayAddressesLast defaultAddressSort publicAddressesFirst diff --git a/modules/_libp2p_utils.array_equals.html b/modules/_libp2p_utils.array_equals.html index 68ac3598d1..755649fb36 100644 --- a/modules/_libp2p_utils.array_equals.html +++ b/modules/_libp2p_utils.array_equals.html @@ -1,5 +1,5 @@ array-equals | libp2p

                                                                                                                                                                                                            Module array-equals

                                                                                                                                                                                                            Provides strategies ensure arrays are equivalent.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { arrayEquals } from '@libp2p/utils/array-equals'
                                                                                                                                                                                                            import { multiaddr } from '@multformats/multiaddr'

                                                                                                                                                                                                            const ma1 = multiaddr('/ip4/127.0.0.1/tcp/9000'),
                                                                                                                                                                                                            const ma2 = multiaddr('/ip4/82.41.53.1/tcp/9000')

                                                                                                                                                                                                            console.info(arrayEquals([ma1], [ma1])) // true
                                                                                                                                                                                                            console.info(arrayEquals([ma1], [ma2])) // false
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            arrayEquals +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            arrayEquals

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.close.html b/modules/_libp2p_utils.close.html index 17b06f9303..7f8af5981d 100644 --- a/modules/_libp2p_utils.close.html +++ b/modules/_libp2p_utils.close.html @@ -1,4 +1,4 @@ -close | libp2p

                                                                                                                                                                                                            Module close

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            SafelyCloseConnectionOptions +close | libp2p

                                                                                                                                                                                                            Module close

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            SafelyCloseConnectionOptions

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            safelyCloseConnectionIfUnused safelyCloseStream

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.close_source.html b/modules/_libp2p_utils.close_source.html index bcc3baf9c8..32675e11a5 100644 --- a/modules/_libp2p_utils.close_source.html +++ b/modules/_libp2p_utils.close_source.html @@ -1,2 +1,2 @@ -close-source | libp2p

                                                                                                                                                                                                            Module close-source

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            closeSource +close-source | libp2p

                                                                                                                                                                                                            Module close-source

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            closeSource

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.filters.html b/modules/_libp2p_utils.filters.html index bd02abf885..c3f7cdca6c 100644 --- a/modules/_libp2p_utils.filters.html +++ b/modules/_libp2p_utils.filters.html @@ -1,4 +1,4 @@ -filters | libp2p

                                                                                                                                                                                                            Module filters

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            BloomFilter +filters | libp2p

                                                                                                                                                                                                            Module filters

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            BloomFilter CuckooFilter ScalableCuckooFilter

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            BloomFilterOptions diff --git a/modules/_libp2p_utils.index.html b/modules/_libp2p_utils.index.html index 052bc97a65..d1ec00ef31 100644 --- a/modules/_libp2p_utils.index.html +++ b/modules/_libp2p_utils.index.html @@ -7,4 +7,4 @@

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            Each function should be imported directly.

                                                                                                                                                                                                            import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'

                                                                                                                                                                                                            const ma = ipPortToMultiaddr('127.0.0.1', 9000)
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.ip_port_to_multiaddr.html b/modules/_libp2p_utils.ip_port_to_multiaddr.html index 0e318b5991..c53be86bae 100644 --- a/modules/_libp2p_utils.ip_port_to_multiaddr.html +++ b/modules/_libp2p_utils.ip_port_to_multiaddr.html @@ -1,3 +1,3 @@ -ip-port-to-multiaddr | libp2p

                                                                                                                                                                                                            Module ip-port-to-multiaddr

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            Errors +ip-port-to-multiaddr | libp2p

                                                                                                                                                                                                            Module ip-port-to-multiaddr

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            Errors

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            ipPortToMultiaddr

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.is_promise.html b/modules/_libp2p_utils.is_promise.html index 321633d82e..839a1fdf65 100644 --- a/modules/_libp2p_utils.is_promise.html +++ b/modules/_libp2p_utils.is_promise.html @@ -1,2 +1,2 @@ -is-promise | libp2p

                                                                                                                                                                                                            Module is-promise

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPromise +is-promise | libp2p

                                                                                                                                                                                                            Module is-promise

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPromise

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.moving_average.html b/modules/_libp2p_utils.moving_average.html index 52aa8223e9..1fe8eba907 100644 --- a/modules/_libp2p_utils.moving_average.html +++ b/modules/_libp2p_utils.moving_average.html @@ -1,2 +1,2 @@ -moving-average | libp2p

                                                                                                                                                                                                            Module moving-average

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            MovingAverage +moving-average | libp2p

                                                                                                                                                                                                            Module moving-average

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            MovingAverage

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_loopback.html b/modules/_libp2p_utils.multiaddr_is_loopback.html index 532cedc79d..bf31b6ff9b 100644 --- a/modules/_libp2p_utils.multiaddr_is_loopback.html +++ b/modules/_libp2p_utils.multiaddr_is_loopback.html @@ -1,2 +1,2 @@ -multiaddr/is-loopback | libp2p

                                                                                                                                                                                                            Module multiaddr/is-loopback

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isLoopback +multiaddr/is-loopback | libp2p

                                                                                                                                                                                                            Module multiaddr/is-loopback

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isLoopback

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.multiaddr_is_private.html b/modules/_libp2p_utils.multiaddr_is_private.html index 8e42e44b16..182eed5611 100644 --- a/modules/_libp2p_utils.multiaddr_is_private.html +++ b/modules/_libp2p_utils.multiaddr_is_private.html @@ -1,2 +1,2 @@ -multiaddr/is-private | libp2p

                                                                                                                                                                                                            Module multiaddr/is-private

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPrivate +multiaddr/is-private | libp2p

                                                                                                                                                                                                            Module multiaddr/is-private

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPrivate

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.peer_queue.html b/modules/_libp2p_utils.peer_queue.html index 539e37ef79..ae8a5a230d 100644 --- a/modules/_libp2p_utils.peer_queue.html +++ b/modules/_libp2p_utils.peer_queue.html @@ -1,3 +1,3 @@ -peer-queue | libp2p

                                                                                                                                                                                                            Module peer-queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PeerQueue +peer-queue | libp2p

                                                                                                                                                                                                            Module peer-queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PeerQueue

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PeerQueueJobOptions

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.priority_queue.html b/modules/_libp2p_utils.priority_queue.html index 143c59e2b6..e14da5c5f7 100644 --- a/modules/_libp2p_utils.priority_queue.html +++ b/modules/_libp2p_utils.priority_queue.html @@ -1,3 +1,3 @@ -priority-queue | libp2p

                                                                                                                                                                                                            Module priority-queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PriorityQueue +priority-queue | libp2p

                                                                                                                                                                                                            Module priority-queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            PriorityQueue

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            PriorityQueueJobOptions

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.private_ip.html b/modules/_libp2p_utils.private_ip.html index 209eb8b327..d0dd742430 100644 --- a/modules/_libp2p_utils.private_ip.html +++ b/modules/_libp2p_utils.private_ip.html @@ -1,2 +1,2 @@ -private-ip | libp2p

                                                                                                                                                                                                            Module private-ip

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPrivateIp +private-ip | libp2p

                                                                                                                                                                                                            Module private-ip

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            isPrivateIp

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.queue.html b/modules/_libp2p_utils.queue.html index 174d1be57e..1e48f1bdc7 100644 --- a/modules/_libp2p_utils.queue.html +++ b/modules/_libp2p_utils.queue.html @@ -1,4 +1,4 @@ -queue | libp2p

                                                                                                                                                                                                            Module queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            Queue +queue | libp2p

                                                                                                                                                                                                            Module queue

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            Queue

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            Comparator JobMatcher QueueEvents diff --git a/modules/_libp2p_utils.rate_limiter.html b/modules/_libp2p_utils.rate_limiter.html index 7aa82df5f4..f4446921f5 100644 --- a/modules/_libp2p_utils.rate_limiter.html +++ b/modules/_libp2p_utils.rate_limiter.html @@ -1,4 +1,4 @@ -rate-limiter | libp2p

                                                                                                                                                                                                            Module rate-limiter

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            RateLimiter +rate-limiter | libp2p

                                                                                                                                                                                                            Module rate-limiter

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            RateLimiter

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            GetKeySecDurationOptions RateLimiterInit RateLimiterResult diff --git a/modules/_libp2p_utils.stream_to_ma_conn.html b/modules/_libp2p_utils.stream_to_ma_conn.html index ef34d2b1a6..b9d80bcb74 100644 --- a/modules/_libp2p_utils.stream_to_ma_conn.html +++ b/modules/_libp2p_utils.stream_to_ma_conn.html @@ -1,3 +1,3 @@ -stream-to-ma-conn | libp2p

                                                                                                                                                                                                            Module stream-to-ma-conn

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            StreamProperties +stream-to-ma-conn | libp2p

                                                                                                                                                                                                            Module stream-to-ma-conn

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            StreamProperties

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            streamToMaConnection

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.tracked_list.html b/modules/_libp2p_utils.tracked_list.html index bb63410aba..8e9bef0b98 100644 --- a/modules/_libp2p_utils.tracked_list.html +++ b/modules/_libp2p_utils.tracked_list.html @@ -1,3 +1,3 @@ -tracked-list | libp2p

                                                                                                                                                                                                            Module tracked-list

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            CreateTrackedListInit +tracked-list | libp2p

                                                                                                                                                                                                            Module tracked-list

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            CreateTrackedListInit

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            trackedList

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_utils.tracked_map.html b/modules/_libp2p_utils.tracked_map.html index a1e7364dc2..f357177fde 100644 --- a/modules/_libp2p_utils.tracked_map.html +++ b/modules/_libp2p_utils.tracked_map.html @@ -1,4 +1,4 @@ -tracked-map | libp2p

                                                                                                                                                                                                            Module tracked-map

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            CreateTrackedMapInit +tracked-map | libp2p

                                                                                                                                                                                                            Module tracked-map

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            CreateTrackedMapInit TrackedMapInit

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            trackedMap

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/modules/_libp2p_websockets.filters.html b/modules/_libp2p_websockets.filters.html index ed44de2471..5267fb8f4d 100644 --- a/modules/_libp2p_websockets.filters.html +++ b/modules/_libp2p_websockets.filters.html @@ -1,4 +1,4 @@ -filters | libp2p

                                                                                                                                                                                                            Module filters

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            all +filters | libp2p

                                                                                                                                                                                                            Module filters

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Functions

                                                                                                                                                                                                            all dnsWsOrWss dnsWss wss diff --git a/modules/_libp2p_websockets.index.html b/modules/_libp2p_websockets.index.html index 6390e53aed..75a33e4c76 100644 --- a/modules/_libp2p_websockets.index.html +++ b/modules/_libp2p_websockets.index.html @@ -21,7 +21,7 @@

                                                                                                                                                                                                            Example: Allow dialing insecure WebSockets

                                                                                                                                                                                                            import { createLibp2p } from 'libp2p'
                                                                                                                                                                                                            import { webSockets } from '@libp2p/websockets'
                                                                                                                                                                                                            import * as filters from '@libp2p/websockets/filters'

                                                                                                                                                                                                            const node = await createLibp2p({
                                                                                                                                                                                                              transports: [
                                                                                                                                                                                                                webSockets({
                                                                                                                                                                                                                  // connect to all sockets, even insecure ones
                                                                                                                                                                                                                  filter: filters.all
                                                                                                                                                                                                                })
                                                                                                                                                                                                              ]
                                                                                                                                                                                                            })
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            WebSocketsComponents +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            WebSocketsComponents WebSocketsInit WebSocketsMetrics

                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                            WebSocketsDialEvents diff --git a/modules/libp2p.index.html b/modules/libp2p.index.html index 882eb0f23d..09fbaf890e 100644 --- a/modules/libp2p.index.html +++ b/modules/libp2p.index.html @@ -1,7 +1,7 @@ index | libp2p

                                                                                                                                                                                                            Module index

                                                                                                                                                                                                            Use the createLibp2p function to create a libp2p node.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { createLibp2p } from 'libp2p'

                                                                                                                                                                                                            const node = await createLibp2p({
                                                                                                                                                                                                              // ...other options
                                                                                                                                                                                                            })
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            Libp2p +

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                            Libp2p Libp2pInit

                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                            Libp2pOptions ServiceFactoryMap diff --git a/modules/libp2p.version.html b/modules/libp2p.version.html index f1fcf810ee..43ccfae664 100644 --- a/modules/libp2p.version.html +++ b/modules/libp2p.version.html @@ -1,3 +1,3 @@ -version | libp2p

                                                                                                                                                                                                            Module version

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            name +version | libp2p

                                                                                                                                                                                                            Module version

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Variables

                                                                                                                                                                                                            name version

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.ApplicationMessage.html b/types/_libp2p_devtools_metrics.ApplicationMessage.html index 6bf37dcaf3..72061442e8 100644 --- a/types/_libp2p_devtools_metrics.ApplicationMessage.html +++ b/types/_libp2p_devtools_metrics.ApplicationMessage.html @@ -1,2 +1,2 @@ ApplicationMessage | libp2p

                                                                                                                                                                                                            Type alias ApplicationMessage

                                                                                                                                                                                                            ApplicationMessage: RPCMessage

                                                                                                                                                                                                            Messages that are sent from the application page to the DevTools panel

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.DevToolsMessage.html b/types/_libp2p_devtools_metrics.DevToolsMessage.html index d0cb55c8b8..2d9b348301 100644 --- a/types/_libp2p_devtools_metrics.DevToolsMessage.html +++ b/types/_libp2p_devtools_metrics.DevToolsMessage.html @@ -1,2 +1,2 @@ DevToolsMessage | libp2p

                                                                                                                                                                                                            Type alias DevToolsMessage

                                                                                                                                                                                                            DevToolsMessage: CopyToClipboardMessage | RPCMessage

                                                                                                                                                                                                            Messages that are sent from the DevTools panel page to the application page

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_devtools_metrics.WorkerMessage.html b/types/_libp2p_devtools_metrics.WorkerMessage.html index 55108a393e..a878692d74 100644 --- a/types/_libp2p_devtools_metrics.WorkerMessage.html +++ b/types/_libp2p_devtools_metrics.WorkerMessage.html @@ -1,2 +1,2 @@ WorkerMessage | libp2p

                                                                                                                                                                                                            Type alias WorkerMessage

                                                                                                                                                                                                            WorkerMessage: PageLoadedMessage | PermissionsErrorMessage

                                                                                                                                                                                                            Messages that are sent from the service worker

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.CalculateMetric.html b/types/_libp2p_interface.CalculateMetric.html index c62ede4fab..ee63e8fd58 100644 --- a/types/_libp2p_interface.CalculateMetric.html +++ b/types/_libp2p_interface.CalculateMetric.html @@ -1,3 +1,3 @@ CalculateMetric | libp2p

                                                                                                                                                                                                            Type alias CalculateMetric<T>

                                                                                                                                                                                                            CalculateMetric<T>: (() => T) | (() => Promise<T>)

                                                                                                                                                                                                            A function that returns a tracked metric which may be expensive to calculate so it is only invoked when metrics are being scraped

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • T = number

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                              • (): T

                                                                                                                                                                                                              • Returns T

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • T = number

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                              • (): T

                                                                                                                                                                                                              • Returns T

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.ConnectionStatus.html b/types/_libp2p_interface.ConnectionStatus.html index bc0d7e4247..81c8851118 100644 --- a/types/_libp2p_interface.ConnectionStatus.html +++ b/types/_libp2p_interface.ConnectionStatus.html @@ -1 +1 @@ -ConnectionStatus | libp2p

                                                                                                                                                                                                            Type alias ConnectionStatus

                                                                                                                                                                                                            ConnectionStatus: "open" | "closing" | "closed"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ConnectionStatus | libp2p

                                                                                                                                                                                                            Type alias ConnectionStatus

                                                                                                                                                                                                            ConnectionStatus: "open" | "closing" | "closed"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.Direction.html b/types/_libp2p_interface.Direction.html index addacac488..c17c7b732d 100644 --- a/types/_libp2p_interface.Direction.html +++ b/types/_libp2p_interface.Direction.html @@ -1,2 +1,2 @@ Direction | libp2p

                                                                                                                                                                                                            Type alias Direction

                                                                                                                                                                                                            Direction: "inbound" | "outbound"

                                                                                                                                                                                                            Outbound connections are opened by the local node, inbound streams are opened by the remote

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.EventHandler.html b/types/_libp2p_interface.EventHandler.html index d67cc9633e..fdfb645c94 100644 --- a/types/_libp2p_interface.EventHandler.html +++ b/types/_libp2p_interface.EventHandler.html @@ -1 +1 @@ -EventHandler | libp2p

                                                                                                                                                                                                            Type alias EventHandler<EventType>

                                                                                                                                                                                                            EventHandler<EventType>: EventCallback<EventType> | EventObject<EventType>

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • EventType

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +EventHandler | libp2p

                                                                                                                                                                                                            Type alias EventHandler<EventType>

                                                                                                                                                                                                            EventHandler<EventType>: EventCallback<EventType> | EventObject<EventType>

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • EventType

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.InboundConnectionUpgradeEvents.html b/types/_libp2p_interface.InboundConnectionUpgradeEvents.html index 6d6438dfb1..7f49ca528c 100644 --- a/types/_libp2p_interface.InboundConnectionUpgradeEvents.html +++ b/types/_libp2p_interface.InboundConnectionUpgradeEvents.html @@ -1 +1 @@ -InboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                            Type alias InboundConnectionUpgradeEvents

                                                                                                                                                                                                            InboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-inbound-connection"> | ProgressEvent<"upgrader:multiplex-inbound-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +InboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                            Type alias InboundConnectionUpgradeEvents

                                                                                                                                                                                                            InboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-inbound-connection"> | ProgressEvent<"upgrader:multiplex-inbound-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.KeyType.html b/types/_libp2p_interface.KeyType.html index c595ea2ade..cd0b166aca 100644 --- a/types/_libp2p_interface.KeyType.html +++ b/types/_libp2p_interface.KeyType.html @@ -1 +1 @@ -KeyType | libp2p

                                                                                                                                                                                                            Type alias KeyType

                                                                                                                                                                                                            KeyType: typeof Ed25519 | typeof RSA | typeof secp256k1

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +KeyType | libp2p

                                                                                                                                                                                                            Type alias KeyType

                                                                                                                                                                                                            KeyType: typeof Ed25519 | typeof RSA | typeof secp256k1

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.Libp2pStatus.html b/types/_libp2p_interface.Libp2pStatus.html index 4c33e769dc..ef6c38cc53 100644 --- a/types/_libp2p_interface.Libp2pStatus.html +++ b/types/_libp2p_interface.Libp2pStatus.html @@ -1 +1 @@ -Libp2pStatus | libp2p

                                                                                                                                                                                                            Type alias Libp2pStatus

                                                                                                                                                                                                            Libp2pStatus: "starting" | "started" | "stopping" | "stopped"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +Libp2pStatus | libp2p

                                                                                                                                                                                                            Type alias Libp2pStatus

                                                                                                                                                                                                            Libp2pStatus: "starting" | "started" | "stopping" | "stopped"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.Message.html b/types/_libp2p_interface.Message.html index 4e81f6fb5a..7cd2f71c21 100644 --- a/types/_libp2p_interface.Message.html +++ b/types/_libp2p_interface.Message.html @@ -1 +1 @@ -Message | libp2p

                                                                                                                                                                                                            Type alias Message

                                                                                                                                                                                                            Message: SignedMessage | UnsignedMessage

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +Message | libp2p

                                                                                                                                                                                                            Type alias Message

                                                                                                                                                                                                            Message: SignedMessage | UnsignedMessage

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.OpenConnectionProgressEvents.html b/types/_libp2p_interface.OpenConnectionProgressEvents.html index 3c2efdeafe..539585ca54 100644 --- a/types/_libp2p_interface.OpenConnectionProgressEvents.html +++ b/types/_libp2p_interface.OpenConnectionProgressEvents.html @@ -1 +1 @@ -OpenConnectionProgressEvents | libp2p

                                                                                                                                                                                                            Type alias OpenConnectionProgressEvents

                                                                                                                                                                                                            OpenConnectionProgressEvents: TransportManagerDialProgressEvents | ProgressEvent<"dial-queue:already-connected"> | ProgressEvent<"dial-queue:already-in-dial-queue"> | ProgressEvent<"dial-queue:add-to-dial-queue"> | ProgressEvent<"dial-queue:start-dial"> | ProgressEvent<"dial-queue:calculated-addresses", Address[]> | OutboundConnectionUpgradeEvents

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +OpenConnectionProgressEvents | libp2p

                                                                                                                                                                                                            Type alias OpenConnectionProgressEvents

                                                                                                                                                                                                            OpenConnectionProgressEvents: TransportManagerDialProgressEvents | ProgressEvent<"dial-queue:already-connected"> | ProgressEvent<"dial-queue:already-in-dial-queue"> | ProgressEvent<"dial-queue:add-to-dial-queue"> | ProgressEvent<"dial-queue:start-dial"> | ProgressEvent<"dial-queue:calculated-addresses", Address[]> | OutboundConnectionUpgradeEvents

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html b/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html index 0d193904e2..9fd5fea56d 100644 --- a/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html +++ b/types/_libp2p_interface.OutboundConnectionUpgradeEvents.html @@ -1 +1 @@ -OutboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                            Type alias OutboundConnectionUpgradeEvents

                                                                                                                                                                                                            OutboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-outbound-connection"> | ProgressEvent<"upgrader:multiplex-outbound-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +OutboundConnectionUpgradeEvents | libp2p

                                                                                                                                                                                                            Type alias OutboundConnectionUpgradeEvents

                                                                                                                                                                                                            OutboundConnectionUpgradeEvents: ProgressEvent<"upgrader:encrypt-outbound-connection"> | ProgressEvent<"upgrader:multiplex-outbound-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.PeerIdType.html b/types/_libp2p_interface.PeerIdType.html index e5608f1753..f90c1b12ee 100644 --- a/types/_libp2p_interface.PeerIdType.html +++ b/types/_libp2p_interface.PeerIdType.html @@ -1 +1 @@ -PeerIdType | libp2p

                                                                                                                                                                                                            Type alias PeerIdType

                                                                                                                                                                                                            PeerIdType: KeyType | string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +PeerIdType | libp2p

                                                                                                                                                                                                            Type alias PeerIdType

                                                                                                                                                                                                            PeerIdType: KeyType | string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.PendingDialStatus.html b/types/_libp2p_interface.PendingDialStatus.html index b21069f75f..f0ded35e52 100644 --- a/types/_libp2p_interface.PendingDialStatus.html +++ b/types/_libp2p_interface.PendingDialStatus.html @@ -1 +1 @@ -PendingDialStatus | libp2p

                                                                                                                                                                                                            Type alias PendingDialStatus

                                                                                                                                                                                                            PendingDialStatus: "queued" | "active" | "error" | "success"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +PendingDialStatus | libp2p

                                                                                                                                                                                                            Type alias PendingDialStatus

                                                                                                                                                                                                            PendingDialStatus: "queued" | "active" | "error" | "success"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.ReadStatus.html b/types/_libp2p_interface.ReadStatus.html index 234c29334d..6f3608c4a0 100644 --- a/types/_libp2p_interface.ReadStatus.html +++ b/types/_libp2p_interface.ReadStatus.html @@ -2,4 +2,4 @@

                                                                                                                                                                                                            ready - the readable end is ready for reading closing - the readable end is closing closed - the readable end has closed

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.ServiceMap.html b/types/_libp2p_interface.ServiceMap.html index 43a4e581b4..ab8fd4ff9c 100644 --- a/types/_libp2p_interface.ServiceMap.html +++ b/types/_libp2p_interface.ServiceMap.html @@ -2,4 +2,4 @@ services key

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            const node = await createLibp2p({
                                                                                                                                                                                                              // ...other options
                                                                                                                                                                                                              services: {
                                                                                                                                                                                                                myService: myService({
                                                                                                                                                                                                                  // ...service options
                                                                                                                                                                                                                })
                                                                                                                                                                                                              }
                                                                                                                                                                                                            })

                                                                                                                                                                                                            // invoke methods on the service
                                                                                                                                                                                                            node.services.myService.anOperation()
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.SignaturePolicy.html b/types/_libp2p_interface.SignaturePolicy.html index ace57656f4..b78bc8e8f5 100644 --- a/types/_libp2p_interface.SignaturePolicy.html +++ b/types/_libp2p_interface.SignaturePolicy.html @@ -1 +1 @@ -SignaturePolicy | libp2p

                                                                                                                                                                                                            Type alias SignaturePolicy

                                                                                                                                                                                                            SignaturePolicy: typeof StrictSign | typeof StrictNoSign

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +SignaturePolicy | libp2p

                                                                                                                                                                                                            Type alias SignaturePolicy

                                                                                                                                                                                                            SignaturePolicy: typeof StrictSign | typeof StrictNoSign

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.StreamStatus.html b/types/_libp2p_interface.StreamStatus.html index c3baa5ba31..2619f1c71c 100644 --- a/types/_libp2p_interface.StreamStatus.html +++ b/types/_libp2p_interface.StreamStatus.html @@ -1,2 +1,2 @@ StreamStatus | libp2p

                                                                                                                                                                                                            Type alias StreamStatus

                                                                                                                                                                                                            StreamStatus: "open" | "closing" | "closed" | "aborted" | "reset"

                                                                                                                                                                                                            The states a stream can be in

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.TransportManagerDialProgressEvents.html b/types/_libp2p_interface.TransportManagerDialProgressEvents.html index 457f4a8d35..f0f6b4e095 100644 --- a/types/_libp2p_interface.TransportManagerDialProgressEvents.html +++ b/types/_libp2p_interface.TransportManagerDialProgressEvents.html @@ -1 +1 @@ -TransportManagerDialProgressEvents | libp2p

                                                                                                                                                                                                            Type alias TransportManagerDialProgressEvents

                                                                                                                                                                                                            TransportManagerDialProgressEvents: ProgressEvent<"transport-manager:selected-transport", string>

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +TransportManagerDialProgressEvents | libp2p

                                                                                                                                                                                                            Type alias TransportManagerDialProgressEvents

                                                                                                                                                                                                            TransportManagerDialProgressEvents: ProgressEvent<"transport-manager:selected-transport", string>

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_interface.WriteStatus.html b/types/_libp2p_interface.WriteStatus.html index 17476fae90..dbc9b696d2 100644 --- a/types/_libp2p_interface.WriteStatus.html +++ b/types/_libp2p_interface.WriteStatus.html @@ -4,4 +4,4 @@ done - the source passed to the .sink function yielded all values without error closing - the writable end is closing closed - the writable end has closed

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_kad_dht.DHTProgressEvents.html b/types/_libp2p_kad_dht.DHTProgressEvents.html index f1bd49f4a6..9a4e48b121 100644 --- a/types/_libp2p_kad_dht.DHTProgressEvents.html +++ b/types/_libp2p_kad_dht.DHTProgressEvents.html @@ -1 +1 @@ -DHTProgressEvents | libp2p

                                                                                                                                                                                                            Type alias DHTProgressEvents

                                                                                                                                                                                                            DHTProgressEvents: ProgressEvent<"kad-dht:query:send-query", SendQueryEvent> | ProgressEvent<"kad-dht:query:peer-response", PeerResponseEvent> | ProgressEvent<"kad-dht:query:final-peer", FinalPeerEvent> | ProgressEvent<"kad-dht:query:query-error", QueryErrorEvent> | ProgressEvent<"kad-dht:query:provider", ProviderEvent> | ProgressEvent<"kad-dht:query:value", ValueEvent> | ProgressEvent<"kad-dht:query:add-peer", AddPeerEvent> | ProgressEvent<"kad-dht:query:dial-peer", DialPeerEvent>

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +DHTProgressEvents | libp2p

                                                                                                                                                                                                            Type alias DHTProgressEvents

                                                                                                                                                                                                            DHTProgressEvents: ProgressEvent<"kad-dht:query:send-query", SendQueryEvent> | ProgressEvent<"kad-dht:query:peer-response", PeerResponseEvent> | ProgressEvent<"kad-dht:query:final-peer", FinalPeerEvent> | ProgressEvent<"kad-dht:query:query-error", QueryErrorEvent> | ProgressEvent<"kad-dht:query:provider", ProviderEvent> | ProgressEvent<"kad-dht:query:value", ValueEvent> | ProgressEvent<"kad-dht:query:add-peer", AddPeerEvent> | ProgressEvent<"kad-dht:query:dial-peer", DialPeerEvent>

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_kad_dht.MessageName.html b/types/_libp2p_kad_dht.MessageName.html index 86d6e81bbf..765626e904 100644 --- a/types/_libp2p_kad_dht.MessageName.html +++ b/types/_libp2p_kad_dht.MessageName.html @@ -1 +1 @@ -MessageName | libp2p

                                                                                                                                                                                                            Type alias MessageName

                                                                                                                                                                                                            MessageName: keyof typeof MessageType

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +MessageName | libp2p

                                                                                                                                                                                                            Type alias MessageName

                                                                                                                                                                                                            MessageName: keyof typeof MessageType

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_kad_dht.QueryEvent.html b/types/_libp2p_kad_dht.QueryEvent.html index 5747dfb75a..39d977e421 100644 --- a/types/_libp2p_kad_dht.QueryEvent.html +++ b/types/_libp2p_kad_dht.QueryEvent.html @@ -1 +1 @@ -QueryEvent | libp2p

                                                                                                                                                                                                            Type alias QueryEvent

                                                                                                                                                                                                            QueryEvent: SendQueryEvent | PeerResponseEvent | FinalPeerEvent | QueryErrorEvent | ProviderEvent | ValueEvent | AddPeerEvent | DialPeerEvent

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +QueryEvent | libp2p

                                                                                                                                                                                                            Type alias QueryEvent

                                                                                                                                                                                                            QueryEvent: SendQueryEvent | PeerResponseEvent | FinalPeerEvent | QueryErrorEvent | ProviderEvent | ValueEvent | AddPeerEvent | DialPeerEvent

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_kad_dht.Selectors.html b/types/_libp2p_kad_dht.Selectors.html index 949c1b0501..747c647589 100644 --- a/types/_libp2p_kad_dht.Selectors.html +++ b/types/_libp2p_kad_dht.Selectors.html @@ -1,2 +1,2 @@ Selectors | libp2p

                                                                                                                                                                                                            Type alias Selectors

                                                                                                                                                                                                            Selectors: Record<string, SelectFn>

                                                                                                                                                                                                            Selectors are a map of key prefixes to selector functions

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_kad_dht.Validators.html b/types/_libp2p_kad_dht.Validators.html index cc54568608..6340cdb071 100644 --- a/types/_libp2p_kad_dht.Validators.html +++ b/types/_libp2p_kad_dht.Validators.html @@ -1,2 +1,2 @@ Validators | libp2p

                                                                                                                                                                                                            Type alias Validators

                                                                                                                                                                                                            Validators: Record<string, ValidateFn>

                                                                                                                                                                                                            Validators are a map of key prefixes to validator functions

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_tcp.TCPDialEvents.html b/types/_libp2p_tcp.TCPDialEvents.html index e526ba438b..60a0e32fb8 100644 --- a/types/_libp2p_tcp.TCPDialEvents.html +++ b/types/_libp2p_tcp.TCPDialEvents.html @@ -1 +1 @@ -TCPDialEvents | libp2p

                                                                                                                                                                                                            Type alias TCPDialEvents

                                                                                                                                                                                                            TCPDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"tcp:open-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +TCPDialEvents | libp2p

                                                                                                                                                                                                            Type alias TCPDialEvents

                                                                                                                                                                                                            TCPDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"tcp:open-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_utils.queue.JobStatus.html b/types/_libp2p_utils.queue.JobStatus.html index dd6c8f452a..ab625c0796 100644 --- a/types/_libp2p_utils.queue.JobStatus.html +++ b/types/_libp2p_utils.queue.JobStatus.html @@ -1 +1 @@ -JobStatus | libp2p

                                                                                                                                                                                                            Type alias JobStatus

                                                                                                                                                                                                            JobStatus: "queued" | "running" | "errored" | "complete"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +JobStatus | libp2p

                                                                                                                                                                                                            Type alias JobStatus

                                                                                                                                                                                                            JobStatus: "queued" | "running" | "errored" | "complete"

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_websockets.index.WebSocketsDialEvents.html b/types/_libp2p_websockets.index.WebSocketsDialEvents.html index b79e4fd411..0215222fb2 100644 --- a/types/_libp2p_websockets.index.WebSocketsDialEvents.html +++ b/types/_libp2p_websockets.index.WebSocketsDialEvents.html @@ -1 +1 @@ -WebSocketsDialEvents | libp2p

                                                                                                                                                                                                            Type alias WebSocketsDialEvents

                                                                                                                                                                                                            WebSocketsDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"websockets:open-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +WebSocketsDialEvents | libp2p

                                                                                                                                                                                                            Type alias WebSocketsDialEvents

                                                                                                                                                                                                            WebSocketsDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"websockets:open-connection">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/_libp2p_webtransport.WebTransportDialEvents.html b/types/_libp2p_webtransport.WebTransportDialEvents.html index d517428bef..d42336d316 100644 --- a/types/_libp2p_webtransport.WebTransportDialEvents.html +++ b/types/_libp2p_webtransport.WebTransportDialEvents.html @@ -1 +1 @@ -WebTransportDialEvents | libp2p

                                                                                                                                                                                                            Type alias WebTransportDialEvents

                                                                                                                                                                                                            WebTransportDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"webtransport:wait-for-session"> | ProgressEvent<"webtransport:open-authentication-stream"> | ProgressEvent<"webtransport:secure-outbound-connection"> | ProgressEvent<"webtransport:close-authentication-stream">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +WebTransportDialEvents | libp2p

                                                                                                                                                                                                            Type alias WebTransportDialEvents

                                                                                                                                                                                                            WebTransportDialEvents: OutboundConnectionUpgradeEvents | ProgressEvent<"webtransport:wait-for-session"> | ProgressEvent<"webtransport:open-authentication-stream"> | ProgressEvent<"webtransport:secure-outbound-connection"> | ProgressEvent<"webtransport:close-authentication-stream">

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/libp2p.index.Libp2pOptions.html b/types/libp2p.index.Libp2pOptions.html index 72772448c0..285103ddbb 100644 --- a/types/libp2p.index.Libp2pOptions.html +++ b/types/libp2p.index.Libp2pOptions.html @@ -1 +1 @@ -Libp2pOptions | libp2p

                                                                                                                                                                                                            Type alias Libp2pOptions<T>

                                                                                                                                                                                                            Libp2pOptions<T>: Libp2pInit<T> & {
                                                                                                                                                                                                                start?: boolean;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • Optional start?: boolean

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +Libp2pOptions | libp2p

                                                                                                                                                                                                            Type alias Libp2pOptions<T>

                                                                                                                                                                                                            Libp2pOptions<T>: Libp2pInit<T> & {
                                                                                                                                                                                                                start?: boolean;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • Optional start?: boolean

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/types/libp2p.index.ServiceFactoryMap.html b/types/libp2p.index.ServiceFactoryMap.html index 3b07477b5f..f7267b0ec6 100644 --- a/types/libp2p.index.ServiceFactoryMap.html +++ b/types/libp2p.index.ServiceFactoryMap.html @@ -1 +1 @@ -ServiceFactoryMap | libp2p

                                                                                                                                                                                                            Type alias ServiceFactoryMap<T>

                                                                                                                                                                                                            ServiceFactoryMap<T>: {
                                                                                                                                                                                                                [Property in keyof T]: ((components) => T[Property])
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ServiceFactoryMap | libp2p

                                                                                                                                                                                                            Type alias ServiceFactoryMap<T>

                                                                                                                                                                                                            ServiceFactoryMap<T>: {
                                                                                                                                                                                                                [Property in keyof T]: ((components) => T[Property])
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html b/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html index f3e6b4ebb5..e42bac1606 100644 --- a/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html +++ b/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html @@ -1,2 +1,2 @@ RELAY_V2_HOP_CODEC | libp2p

                                                                                                                                                                                                            Variable RELAY_V2_HOP_CODECConst

                                                                                                                                                                                                            RELAY_V2_HOP_CODEC: "/libp2p/circuit/relay/0.2.0/hop" = '/libp2p/circuit/relay/0.2.0/hop'

                                                                                                                                                                                                            The hop protocol

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html b/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html index eeb4d48e27..7092713536 100644 --- a/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html +++ b/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html @@ -1,2 +1,2 @@ RELAY_V2_STOP_CODEC | libp2p

                                                                                                                                                                                                            Variable RELAY_V2_STOP_CODECConst

                                                                                                                                                                                                            RELAY_V2_STOP_CODEC: "/libp2p/circuit/relay/0.2.0/stop" = '/libp2p/circuit/relay/0.2.0/stop'

                                                                                                                                                                                                            the stop protocol

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html b/variables/_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html index e9a4528836..364fc73ebf 100644 --- a/variables/_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html +++ b/variables/_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html @@ -1 +1 @@ -MAX_RSA_KEY_SIZE | libp2p

                                                                                                                                                                                                            Variable MAX_RSA_KEY_SIZEConst

                                                                                                                                                                                                            MAX_RSA_KEY_SIZE: 8192 = 8192

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +MAX_RSA_KEY_SIZE | libp2p

                                                                                                                                                                                                            Variable MAX_RSA_KEY_SIZEConst

                                                                                                                                                                                                            MAX_RSA_KEY_SIZE: 8192 = 8192

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_crypto.keys.supportedKeys.html b/variables/_libp2p_crypto.keys.supportedKeys.html index 89a6152be7..6aa74e8a8c 100644 --- a/variables/_libp2p_crypto.keys.supportedKeys.html +++ b/variables/_libp2p_crypto.keys.supportedKeys.html @@ -1 +1 @@ -supportedKeys | libp2p

                                                                                                                                                                                                            Variable supportedKeysConst

                                                                                                                                                                                                            supportedKeys: {
                                                                                                                                                                                                                ed25519: __module;
                                                                                                                                                                                                                rsa: __module;
                                                                                                                                                                                                                secp256k1: __module;
                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +supportedKeys | libp2p

                                                                                                                                                                                                            Variable supportedKeysConst

                                                                                                                                                                                                            supportedKeys: {
                                                                                                                                                                                                                ed25519: __module;
                                                                                                                                                                                                                rsa: __module;
                                                                                                                                                                                                                secp256k1: __module;
                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_dcutr.multicodec.html b/variables/_libp2p_dcutr.multicodec.html index b5d3965daf..f6df88109e 100644 --- a/variables/_libp2p_dcutr.multicodec.html +++ b/variables/_libp2p_dcutr.multicodec.html @@ -1,2 +1,2 @@ multicodec | libp2p

                                                                                                                                                                                                            Variable multicodecConst

                                                                                                                                                                                                            multicodec: "/libp2p/dcutr" = '/libp2p/dcutr'

                                                                                                                                                                                                            The DCUtR protocol

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html b/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html index 56405bae8c..2e44c52fb4 100644 --- a/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html +++ b/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html @@ -1 +1 @@ -LIBP2P_DEVTOOLS_METRICS_KEY | libp2p

                                                                                                                                                                                                            Variable LIBP2P_DEVTOOLS_METRICS_KEYConst

                                                                                                                                                                                                            LIBP2P_DEVTOOLS_METRICS_KEY: "________libp2p_devtools_metrics" = '________libp2p_devtools_metrics'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +LIBP2P_DEVTOOLS_METRICS_KEY | libp2p

                                                                                                                                                                                                            Variable LIBP2P_DEVTOOLS_METRICS_KEYConst

                                                                                                                                                                                                            LIBP2P_DEVTOOLS_METRICS_KEY: "________libp2p_devtools_metrics" = '________libp2p_devtools_metrics'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html b/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html index e3ee9668e2..4bdf40ebee 100644 --- a/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html +++ b/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html @@ -1 +1 @@ -SOURCE_CONTENT_SCRIPT | libp2p

                                                                                                                                                                                                            Variable SOURCE_CONTENT_SCRIPTConst

                                                                                                                                                                                                            SOURCE_CONTENT_SCRIPT: "@libp2p/devtools-metrics:content" = '@libp2p/devtools-metrics:content'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +SOURCE_CONTENT_SCRIPT | libp2p

                                                                                                                                                                                                            Variable SOURCE_CONTENT_SCRIPTConst

                                                                                                                                                                                                            SOURCE_CONTENT_SCRIPT: "@libp2p/devtools-metrics:content" = '@libp2p/devtools-metrics:content'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html b/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html index 5d8ee69eab..36da77da46 100644 --- a/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html +++ b/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html @@ -1 +1 @@ -SOURCE_DEVTOOLS | libp2p

                                                                                                                                                                                                            Variable SOURCE_DEVTOOLSConst

                                                                                                                                                                                                            SOURCE_DEVTOOLS: "@libp2p/devtools-metrics:devtools" = '@libp2p/devtools-metrics:devtools'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +SOURCE_DEVTOOLS | libp2p

                                                                                                                                                                                                            Variable SOURCE_DEVTOOLSConst

                                                                                                                                                                                                            SOURCE_DEVTOOLS: "@libp2p/devtools-metrics:devtools" = '@libp2p/devtools-metrics:devtools'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html b/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html index 8cbdf6001e..239e738702 100644 --- a/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html +++ b/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html @@ -1 +1 @@ -SOURCE_METRICS | libp2p

                                                                                                                                                                                                            Variable SOURCE_METRICSConst

                                                                                                                                                                                                            SOURCE_METRICS: "@libp2p/devtools-metrics:metrics" = '@libp2p/devtools-metrics:metrics'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +SOURCE_METRICS | libp2p

                                                                                                                                                                                                            Variable SOURCE_METRICSConst

                                                                                                                                                                                                            SOURCE_METRICS: "@libp2p/devtools-metrics:metrics" = '@libp2p/devtools-metrics:metrics'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html b/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html index 54d4319bd9..6178f13d73 100644 --- a/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html +++ b/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html @@ -1 +1 @@ -SOURCE_SERVICE_WORKER | libp2p

                                                                                                                                                                                                            Variable SOURCE_SERVICE_WORKERConst

                                                                                                                                                                                                            SOURCE_SERVICE_WORKER: "@libp2p/devtools-metrics:worker" = '@libp2p/devtools-metrics:worker'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +SOURCE_SERVICE_WORKER | libp2p

                                                                                                                                                                                                            Variable SOURCE_SERVICE_WORKERConst

                                                                                                                                                                                                            SOURCE_SERVICE_WORKER: "@libp2p/devtools-metrics:worker" = '@libp2p/devtools-metrics:worker'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_devtools_metrics.valueCodecs.html b/variables/_libp2p_devtools_metrics.valueCodecs.html index 98f9334609..900f8f6456 100644 --- a/variables/_libp2p_devtools_metrics.valueCodecs.html +++ b/variables/_libp2p_devtools_metrics.valueCodecs.html @@ -1 +1 @@ -valueCodecs | libp2p

                                                                                                                                                                                                            Variable valueCodecsConst

                                                                                                                                                                                                            valueCodecs: ValueCodec<any>[] = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +valueCodecs | libp2p

                                                                                                                                                                                                            Variable valueCodecsConst

                                                                                                                                                                                                            valueCodecs: ValueCodec<any>[] = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_floodsub.multicodec.html b/variables/_libp2p_floodsub.multicodec.html index fe22597297..c0e09f4e18 100644 --- a/variables/_libp2p_floodsub.multicodec.html +++ b/variables/_libp2p_floodsub.multicodec.html @@ -1 +1 @@ -multicodec | libp2p

                                                                                                                                                                                                            Variable multicodecConst

                                                                                                                                                                                                            multicodec: "/floodsub/1.0.0" = '/floodsub/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +multicodec | libp2p

                                                                                                                                                                                                            Variable multicodecConst

                                                                                                                                                                                                            multicodec: "/floodsub/1.0.0" = '/floodsub/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.CustomEvent.html b/variables/_libp2p_interface.CustomEvent.html index 98948bde86..a16361a311 100644 --- a/variables/_libp2p_interface.CustomEvent.html +++ b/variables/_libp2p_interface.CustomEvent.html @@ -1 +1 @@ -CustomEvent | libp2p

                                                                                                                                                                                                            Variable CustomEventConst

                                                                                                                                                                                                            CustomEvent: {
                                                                                                                                                                                                                prototype: CustomEvent<any>;
                                                                                                                                                                                                                new <T>(type, eventInitDict?): CustomEvent<T>;
                                                                                                                                                                                                            } = globalThis.CustomEvent

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +CustomEvent | libp2p

                                                                                                                                                                                                            Variable CustomEventConst

                                                                                                                                                                                                            CustomEvent: {
                                                                                                                                                                                                                prototype: CustomEvent<any>;
                                                                                                                                                                                                                new <T>(type, eventInitDict?): CustomEvent<T>;
                                                                                                                                                                                                            } = globalThis.CustomEvent

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.ERR_INVALID_MESSAGE.html b/variables/_libp2p_interface.ERR_INVALID_MESSAGE.html index cce6a273da..e97bf6ffdd 100644 --- a/variables/_libp2p_interface.ERR_INVALID_MESSAGE.html +++ b/variables/_libp2p_interface.ERR_INVALID_MESSAGE.html @@ -1 +1 @@ -ERR_INVALID_MESSAGE | libp2p

                                                                                                                                                                                                            Variable ERR_INVALID_MESSAGEConst

                                                                                                                                                                                                            ERR_INVALID_MESSAGE: "ERR_INVALID_MESSAGE" = 'ERR_INVALID_MESSAGE'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ERR_INVALID_MESSAGE | libp2p

                                                                                                                                                                                                            Variable ERR_INVALID_MESSAGEConst

                                                                                                                                                                                                            ERR_INVALID_MESSAGE: "ERR_INVALID_MESSAGE" = 'ERR_INVALID_MESSAGE'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.ERR_INVALID_PARAMETERS.html b/variables/_libp2p_interface.ERR_INVALID_PARAMETERS.html index 7c47c2f832..49c8cbd08c 100644 --- a/variables/_libp2p_interface.ERR_INVALID_PARAMETERS.html +++ b/variables/_libp2p_interface.ERR_INVALID_PARAMETERS.html @@ -1 +1 @@ -ERR_INVALID_PARAMETERS | libp2p

                                                                                                                                                                                                            Variable ERR_INVALID_PARAMETERSConst

                                                                                                                                                                                                            ERR_INVALID_PARAMETERS: "ERR_INVALID_PARAMETERS" = 'ERR_INVALID_PARAMETERS'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ERR_INVALID_PARAMETERS | libp2p

                                                                                                                                                                                                            Variable ERR_INVALID_PARAMETERSConst

                                                                                                                                                                                                            ERR_INVALID_PARAMETERS: "ERR_INVALID_PARAMETERS" = 'ERR_INVALID_PARAMETERS'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.ERR_NOT_FOUND.html b/variables/_libp2p_interface.ERR_NOT_FOUND.html index 91c484a51f..ec85934de6 100644 --- a/variables/_libp2p_interface.ERR_NOT_FOUND.html +++ b/variables/_libp2p_interface.ERR_NOT_FOUND.html @@ -1 +1 @@ -ERR_NOT_FOUND | libp2p

                                                                                                                                                                                                            Variable ERR_NOT_FOUNDConst

                                                                                                                                                                                                            ERR_NOT_FOUND: "ERR_NOT_FOUND" = 'ERR_NOT_FOUND'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ERR_NOT_FOUND | libp2p

                                                                                                                                                                                                            Variable ERR_NOT_FOUNDConst

                                                                                                                                                                                                            ERR_NOT_FOUND: "ERR_NOT_FOUND" = 'ERR_NOT_FOUND'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.ERR_TIMEOUT.html b/variables/_libp2p_interface.ERR_TIMEOUT.html index 55981e6a8f..97596ab921 100644 --- a/variables/_libp2p_interface.ERR_TIMEOUT.html +++ b/variables/_libp2p_interface.ERR_TIMEOUT.html @@ -1 +1 @@ -ERR_TIMEOUT | libp2p

                                                                                                                                                                                                            Variable ERR_TIMEOUTConst

                                                                                                                                                                                                            ERR_TIMEOUT: "ERR_TIMEOUT" = 'ERR_TIMEOUT'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +ERR_TIMEOUT | libp2p

                                                                                                                                                                                                            Variable ERR_TIMEOUTConst

                                                                                                                                                                                                            ERR_TIMEOUT: "ERR_TIMEOUT" = 'ERR_TIMEOUT'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.Ed25519.html b/variables/_libp2p_interface.Ed25519.html index e7b8787d59..bca8f7d606 100644 --- a/variables/_libp2p_interface.Ed25519.html +++ b/variables/_libp2p_interface.Ed25519.html @@ -1 +1 @@ -Ed25519 | libp2p

                                                                                                                                                                                                            Variable Ed25519Const

                                                                                                                                                                                                            Ed25519: "Ed25519" = 'Ed25519'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +Ed25519 | libp2p

                                                                                                                                                                                                            Variable Ed25519Const

                                                                                                                                                                                                            Ed25519: "Ed25519" = 'Ed25519'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.KEEP_ALIVE.html b/variables/_libp2p_interface.KEEP_ALIVE.html index cc0a6c5b63..8fabffbf81 100644 --- a/variables/_libp2p_interface.KEEP_ALIVE.html +++ b/variables/_libp2p_interface.KEEP_ALIVE.html @@ -1 +1 @@ -KEEP_ALIVE | libp2p

                                                                                                                                                                                                            Variable KEEP_ALIVEConst

                                                                                                                                                                                                            KEEP_ALIVE: "keep-alive" = 'keep-alive'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +KEEP_ALIVE | libp2p

                                                                                                                                                                                                            Variable KEEP_ALIVEConst

                                                                                                                                                                                                            KEEP_ALIVE: "keep-alive" = 'keep-alive'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.RSA.html b/variables/_libp2p_interface.RSA.html index 5ebcf76d0d..6118a63642 100644 --- a/variables/_libp2p_interface.RSA.html +++ b/variables/_libp2p_interface.RSA.html @@ -1 +1 @@ -RSA | libp2p

                                                                                                                                                                                                            Variable RSAConst

                                                                                                                                                                                                            RSA: "RSA" = 'RSA'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +RSA | libp2p

                                                                                                                                                                                                            Variable RSAConst

                                                                                                                                                                                                            RSA: "RSA" = 'RSA'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.StrictNoSign.html b/variables/_libp2p_interface.StrictNoSign.html index 06162d2031..2403ce7d9d 100644 --- a/variables/_libp2p_interface.StrictNoSign.html +++ b/variables/_libp2p_interface.StrictNoSign.html @@ -9,4 +9,4 @@
                                                                                                                                                                                                          • Propagate only if the fields are absent, reject otherwise.
                                                                                                                                                                                                          • A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
                                                                                                                                                                                                            • -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.StrictSign.html b/variables/_libp2p_interface.StrictSign.html index 135aa17781..8e7d2dca00 100644 --- a/variables/_libp2p_interface.StrictSign.html +++ b/variables/_libp2p_interface.StrictSign.html @@ -7,4 +7,4 @@
                                                                                                                                                                                                          • Enforce the fields to be present, reject otherwise.
                                                                                                                                                                                                          • Propagate only if the fields are valid and signature can be verified, reject otherwise.
                                                                                                                                                                                                            • -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.connectionSymbol.html b/variables/_libp2p_interface.connectionSymbol.html index 4f1e2df973..aed2d8f600 100644 --- a/variables/_libp2p_interface.connectionSymbol.html +++ b/variables/_libp2p_interface.connectionSymbol.html @@ -1 +1 @@ -connectionSymbol | libp2p

                                                                                                                                                                                                            Variable connectionSymbolConst

                                                                                                                                                                                                            connectionSymbol: typeof connectionSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +connectionSymbol | libp2p

                                                                                                                                                                                                            Variable connectionSymbolConst

                                                                                                                                                                                                            connectionSymbol: typeof connectionSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.contentRoutingSymbol.html b/variables/_libp2p_interface.contentRoutingSymbol.html index 7617f84beb..984759bddb 100644 --- a/variables/_libp2p_interface.contentRoutingSymbol.html +++ b/variables/_libp2p_interface.contentRoutingSymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { contentRoutingSymbol, ContentRouting } from '@libp2p/content-routing'

                                                                                                                                                                                                            class MyContentRouter implements ContentRouting {
                                                                                                                                                                                                              get [contentRoutingSymbol] () {
                                                                                                                                                                                                                return this
                                                                                                                                                                                                              }

                                                                                                                                                                                                              // ...other methods
                                                                                                                                                                                                            }
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.peerDiscoverySymbol.html b/variables/_libp2p_interface.peerDiscoverySymbol.html index 88de490724..c918f99756 100644 --- a/variables/_libp2p_interface.peerDiscoverySymbol.html +++ b/variables/_libp2p_interface.peerDiscoverySymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { peerDiscovery, PeerDiscovery } from '@libp2p/peer-discovery'

                                                                                                                                                                                                            class MyPeerDiscoverer implements PeerDiscovery {
                                                                                                                                                                                                              get [peerDiscovery] () {
                                                                                                                                                                                                                return this
                                                                                                                                                                                                              }

                                                                                                                                                                                                              // ...other methods
                                                                                                                                                                                                            }
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.peerIdSymbol.html b/variables/_libp2p_interface.peerIdSymbol.html index 319265876b..1669f35da9 100644 --- a/variables/_libp2p_interface.peerIdSymbol.html +++ b/variables/_libp2p_interface.peerIdSymbol.html @@ -1 +1 @@ -peerIdSymbol | libp2p

                                                                                                                                                                                                            Variable peerIdSymbolConst

                                                                                                                                                                                                            peerIdSymbol: typeof peerIdSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +peerIdSymbol | libp2p

                                                                                                                                                                                                            Variable peerIdSymbolConst

                                                                                                                                                                                                            peerIdSymbol: typeof peerIdSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.peerRoutingSymbol.html b/variables/_libp2p_interface.peerRoutingSymbol.html index 6958502a02..4c18d05ad0 100644 --- a/variables/_libp2p_interface.peerRoutingSymbol.html +++ b/variables/_libp2p_interface.peerRoutingSymbol.html @@ -3,4 +3,4 @@ Symbol.Iterable can be used to return an Iterable from an Iterator.

                                                                                                                                                                                                            Example

                                                                                                                                                                                                            import { peerRouting, PeerRouting } from '@libp2p/peer-routing'

                                                                                                                                                                                                            class MyPeerRouter implements PeerRouting {
                                                                                                                                                                                                              get [peerRouting] () {
                                                                                                                                                                                                                return this
                                                                                                                                                                                                              }

                                                                                                                                                                                                              // ...other methods
                                                                                                                                                                                                            }
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.secp256k1.html b/variables/_libp2p_interface.secp256k1.html index b9cf9e45b5..23ce4d692a 100644 --- a/variables/_libp2p_interface.secp256k1.html +++ b/variables/_libp2p_interface.secp256k1.html @@ -1 +1 @@ -secp256k1 | libp2p

                                                                                                                                                                                                            Variable secp256k1Const

                                                                                                                                                                                                            secp256k1: "secp256k1" = 'secp256k1'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +secp256k1 | libp2p

                                                                                                                                                                                                            Variable secp256k1Const

                                                                                                                                                                                                            secp256k1: "secp256k1" = 'secp256k1'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.serviceCapabilities.html b/variables/_libp2p_interface.serviceCapabilities.html index 7a31d8ee05..cf6f0eb2fb 100644 --- a/variables/_libp2p_interface.serviceCapabilities.html +++ b/variables/_libp2p_interface.serviceCapabilities.html @@ -2,4 +2,4 @@ provide to other libp2p services.

                                                                                                                                                                                                            The service should define a property with this symbol as the key and the value should be a string array of provided capabilities.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.serviceDependencies.html b/variables/_libp2p_interface.serviceDependencies.html index d5ede59fe7..119d22d49d 100644 --- a/variables/_libp2p_interface.serviceDependencies.html +++ b/variables/_libp2p_interface.serviceDependencies.html @@ -2,4 +2,4 @@ require from other libp2p services.

                                                                                                                                                                                                            The service should define a property with this symbol as the key and the value should be a string array of required capabilities.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface.transportSymbol.html b/variables/_libp2p_interface.transportSymbol.html index f698024841..4d963bf07b 100644 --- a/variables/_libp2p_interface.transportSymbol.html +++ b/variables/_libp2p_interface.transportSymbol.html @@ -1 +1 @@ -transportSymbol | libp2p

                                                                                                                                                                                                            Variable transportSymbolConst

                                                                                                                                                                                                            transportSymbol: typeof transportSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +transportSymbol | libp2p

                                                                                                                                                                                                            Variable transportSymbolConst

                                                                                                                                                                                                            transportSymbol: typeof transportSymbol = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork.html b/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork.html index 49ffc41144..e900b4ddd9 100644 --- a/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork.html +++ b/variables/_libp2p_interface_compliance_tests.mocks.mockNetwork.html @@ -1 +1 @@ -mockNetwork | libp2p

                                                                                                                                                                                                            Variable mockNetworkConst

                                                                                                                                                                                                            mockNetwork: MockNetwork = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +mockNetwork | libp2p

                                                                                                                                                                                                            Variable mockNetworkConst

                                                                                                                                                                                                            mockNetwork: MockNetwork = ...

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_interface_compliance_tests.peers.default.html b/variables/_libp2p_interface_compliance_tests.peers.default.html index 3c080961bd..87f6d60545 100644 --- a/variables/_libp2p_interface_compliance_tests.peers.default.html +++ b/variables/_libp2p_interface_compliance_tests.peers.default.html @@ -1 +1 @@ -default | libp2p

                                                                                                                                                                                                            Variable default

                                                                                                                                                                                                            default: {
                                                                                                                                                                                                                id: string;
                                                                                                                                                                                                                privKey: string;
                                                                                                                                                                                                                pubKey: string;
                                                                                                                                                                                                            }[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • id: string
                                                                                                                                                                                                            • privKey: string
                                                                                                                                                                                                            • pubKey: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +default | libp2p

                                                                                                                                                                                                            Variable default

                                                                                                                                                                                                            default: {
                                                                                                                                                                                                                id: string;
                                                                                                                                                                                                                privKey: string;
                                                                                                                                                                                                                pubKey: string;
                                                                                                                                                                                                            }[]

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • id: string
                                                                                                                                                                                                            • privKey: string
                                                                                                                                                                                                            • pubKey: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_multistream_select.PROTOCOL_ID.html b/variables/_libp2p_multistream_select.PROTOCOL_ID.html index cede10860c..4e37515229 100644 --- a/variables/_libp2p_multistream_select.PROTOCOL_ID.html +++ b/variables/_libp2p_multistream_select.PROTOCOL_ID.html @@ -1 +1 @@ -PROTOCOL_ID | libp2p

                                                                                                                                                                                                            Variable PROTOCOL_IDConst

                                                                                                                                                                                                            PROTOCOL_ID: "/multistream/1.0.0" = '/multistream/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +PROTOCOL_ID | libp2p

                                                                                                                                                                                                            Variable PROTOCOL_IDConst

                                                                                                                                                                                                            PROTOCOL_ID: "/multistream/1.0.0" = '/multistream/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_ping.PING_PROTOCOL.html b/variables/_libp2p_ping.PING_PROTOCOL.html index e52fde3b60..f4094e8f01 100644 --- a/variables/_libp2p_ping.PING_PROTOCOL.html +++ b/variables/_libp2p_ping.PING_PROTOCOL.html @@ -1 +1 @@ -PING_PROTOCOL | libp2p

                                                                                                                                                                                                            Variable PING_PROTOCOLConst

                                                                                                                                                                                                            PING_PROTOCOL: "/ipfs/ping/1.0.0" = '/ipfs/ping/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +PING_PROTOCOL | libp2p

                                                                                                                                                                                                            Variable PING_PROTOCOLConst

                                                                                                                                                                                                            PING_PROTOCOL: "/ipfs/ping/1.0.0" = '/ipfs/ping/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_pubsub.errors.codes.html b/variables/_libp2p_pubsub.errors.codes.html index 3c9557c69c..1f5582f77f 100644 --- a/variables/_libp2p_pubsub.errors.codes.html +++ b/variables/_libp2p_pubsub.errors.codes.html @@ -10,4 +10,4 @@
                                                                                                                                                                                                          • ERR_UNEXPECTED_SEQNO: string

                                                                                                                                                                                                            Message expected to not have a seqno, but does

                                                                                                                                                                                                          • ERR_UNEXPECTED_SIGNATURE: string

                                                                                                                                                                                                            Message expected to not have a signature, but does

                                                                                                                                                                                                          • ERR_UNHANDLED_SIGNATURE_POLICY: string

                                                                                                                                                                                                            Signature policy is unhandled

                                                                                                                                                                                                            -

                                                                                                                                                                                                            • Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_tls.PROTOCOL.html b/variables/_libp2p_tls.PROTOCOL.html index 397aaed635..489cb5ae87 100644 --- a/variables/_libp2p_tls.PROTOCOL.html +++ b/variables/_libp2p_tls.PROTOCOL.html @@ -1 +1 @@ -PROTOCOL | libp2p

                                                                                                                                                                                                            Variable PROTOCOLConst

                                                                                                                                                                                                            PROTOCOL: "/tls/1.0.0" = '/tls/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +PROTOCOL | libp2p

                                                                                                                                                                                                            Variable PROTOCOLConst

                                                                                                                                                                                                            PROTOCOL: "/tls/1.0.0" = '/tls/1.0.0'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html index b791bd4cab..3cbe73d5c4 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_FAILURE_MULTIPLIER.html @@ -1 +1 @@ -DEFAULT_FAILURE_MULTIPLIER | libp2p

                                                                                                                                                                                                            Variable DEFAULT_FAILURE_MULTIPLIERConst

                                                                                                                                                                                                            DEFAULT_FAILURE_MULTIPLIER: 2 = 2

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +DEFAULT_FAILURE_MULTIPLIER | libp2p

                                                                                                                                                                                                            Variable DEFAULT_FAILURE_MULTIPLIERConst

                                                                                                                                                                                                            DEFAULT_FAILURE_MULTIPLIER: 2 = 2

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html index 073eb00268..f20c05e96e 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_MIN_TIMEOUT.html @@ -1 +1 @@ -DEFAULT_MIN_TIMEOUT | libp2p

                                                                                                                                                                                                            Variable DEFAULT_MIN_TIMEOUTConst

                                                                                                                                                                                                            DEFAULT_MIN_TIMEOUT: 2000 = 2000

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +DEFAULT_MIN_TIMEOUT | libp2p

                                                                                                                                                                                                            Variable DEFAULT_MIN_TIMEOUTConst

                                                                                                                                                                                                            DEFAULT_MIN_TIMEOUT: 2000 = 2000

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html index c2fa5f2de2..c929660938 100644 --- a/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html +++ b/variables/_libp2p_utils.adaptive_timeout.DEFAULT_TIMEOUT_MULTIPLIER.html @@ -1 +1 @@ -DEFAULT_TIMEOUT_MULTIPLIER | libp2p

                                                                                                                                                                                                            Variable DEFAULT_TIMEOUT_MULTIPLIERConst

                                                                                                                                                                                                            DEFAULT_TIMEOUT_MULTIPLIER: 1.2 = 1.2

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +DEFAULT_TIMEOUT_MULTIPLIER | libp2p

                                                                                                                                                                                                            Variable DEFAULT_TIMEOUT_MULTIPLIERConst

                                                                                                                                                                                                            DEFAULT_TIMEOUT_MULTIPLIER: 1.2 = 1.2

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html b/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html index 2c8c25133f..16b2c04cf3 100644 --- a/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html +++ b/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html @@ -1 +1 @@ -Errors | libp2p

                                                                                                                                                                                                            Variable ErrorsConst

                                                                                                                                                                                                            Errors: {
                                                                                                                                                                                                                ERR_INVALID_IP: string;
                                                                                                                                                                                                                ERR_INVALID_IP_PARAMETER: string;
                                                                                                                                                                                                                ERR_INVALID_PORT_PARAMETER: string;
                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • ERR_INVALID_IP: string
                                                                                                                                                                                                            • ERR_INVALID_IP_PARAMETER: string
                                                                                                                                                                                                            • ERR_INVALID_PORT_PARAMETER: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +Errors | libp2p

                                                                                                                                                                                                            Variable ErrorsConst

                                                                                                                                                                                                            Errors: {
                                                                                                                                                                                                                ERR_INVALID_IP: string;
                                                                                                                                                                                                                ERR_INVALID_IP_PARAMETER: string;
                                                                                                                                                                                                                ERR_INVALID_PORT_PARAMETER: string;
                                                                                                                                                                                                            } = ...

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                            • ERR_INVALID_IP: string
                                                                                                                                                                                                            • ERR_INVALID_IP_PARAMETER: string
                                                                                                                                                                                                            • ERR_INVALID_PORT_PARAMETER: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/libp2p.version.name.html b/variables/libp2p.version.name.html index 3256300a2a..522db35d9d 100644 --- a/variables/libp2p.version.name.html +++ b/variables/libp2p.version.name.html @@ -1 +1 @@ -name | libp2p

                                                                                                                                                                                                            Variable nameConst

                                                                                                                                                                                                            name: "libp2p" = 'libp2p'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +name | libp2p

                                                                                                                                                                                                            Variable nameConst

                                                                                                                                                                                                            name: "libp2p" = 'libp2p'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file diff --git a/variables/libp2p.version.version.html b/variables/libp2p.version.version.html index fce9491278..7fad737fe6 100644 --- a/variables/libp2p.version.version.html +++ b/variables/libp2p.version.version.html @@ -1 +1 @@ -version | libp2p

                                                                                                                                                                                                            Variable versionConst

                                                                                                                                                                                                            version: "1.9.1" = '1.9.1'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +version | libp2p

                                                                                                                                                                                                            Variable versionConst

                                                                                                                                                                                                            version: "1.9.2" = '1.9.2'

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file