Module @libp2p/interface

Exports a Libp2p type for modules to use as a type argument.

Example

import type { Libp2p } from '@libp2p/interface'

function doSomethingWithLibp2p (node: Libp2p) {
  // ...
}

@libp2p/interface

The interface implemented by a libp2p node

About

Exports a Libp2p type for modules to use as a type argument.

Example

import type { Libp2p } from '@libp2p/interface'

function doSomethingWithLibp2p (node: Libp2p) {
  // ...
}

Install

$ npm i @libp2p/interface

API Docs

https://libp2p.github.io/js-libp2p/modules/_libp2p_interface.html

License

Licensed under either of

Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Index

Enumerations

FaultTolerance TopicValidatorResult

Interfaces

AbortOptions Address AddressSorter CalculatedHistogramOptions CalculatedMetricOptions CalculatedSummaryOptions ComponentLogger Connection ConnectionEncrypter ConnectionGater ConnectionLimits ConnectionProtector ConnectionTimeline ContentRouting ContentRoutingProvider Counter CounterGroup CreateListenerOptions DialOptions DialProtocolOptions DialTransportOptions Ed25519PeerId Ed25519PrivateKey Ed25519PublicKey Envelope EventCallback EventObject Histogram HistogramGroup HistogramOptions IdentifyResult IncomingStreamData IsDialableOptions Libp2p Libp2pEvents Listener ListenerEvents Logger LoggerOptions Metric MetricGroup MetricOptions Metrics MultiaddrConnection MultiaddrConnectionTimeline MultiaddrFilter NewStreamOptions NodeInfo Peer PeerData PeerDiscovery PeerDiscoveryEvents PeerDiscoveryProvider PeerInfo PeerQuery PeerQueryFilter PeerQueryOrder PeerRouting PeerRoutingProvider PeerStore PeerStreamEvents PeerStreams PeerUpdate PendingDial PubSub PubSubEvents PubSubInit PubSubRPC PubSubRPCMessage PubSubRPCSubscription PublishResult RSAPeerId RSAPrivateKey RSAPublicKey Record RoutingOptions Secp256k1PeerId Secp256k1PrivateKey Secp256k1PublicKey SecureConnectionOptions SecuredConnection SignedMessage SignedPeerRecord Startable StopTimer Stream StreamHandler StreamHandlerOptions StreamHandlerRecord StreamMuxer StreamMuxerFactory StreamMuxerInit StreamTimeline Subscription SubscriptionChangeData Summary SummaryGroup SummaryOptions Tag TagOptions TopicValidatorFn Topology TopologyFilter Transport TypedEventTarget URLPeerId UnsignedMessage Upgrader UpgraderOptions

Variables

KEEP_ALIVE StrictNoSign StrictSign connectionSymbol contentRoutingSymbol peerDiscoverySymbol peerIdSymbol peerRoutingSymbol pubSubSymbol serviceCapabilities serviceDependencies transportSymbol

Functions

isConnection isPeerId isPrivateKey isPubSub isPublicKey isStartable isTransport setMaxListeners start stop