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

Classes

AbortError AggregateCodeError CodeError InvalidCryptoExchangeError InvalidCryptoTransmissionError TypedEventEmitter UnexpectedPeerError

Interfaces

AbortOptions Address AddressSorter CalculatedMetricOptions ComponentLogger Connection ConnectionEncrypter ConnectionGater ConnectionHandler ConnectionProtector ConnectionTimeline ContentRouting ContentRoutingProvider Counter CounterGroup CreateListenerOptions DialOptions Ed25519PeerId Envelope EventCallback EventObject IdentifyResult IncomingStreamData IsDialableOptions Libp2p Libp2pEvents Listener ListenerEvents Logger LoggerOptions Metric MetricGroup MetricOptions Metrics MultiaddrConnection MultiaddrConnectionTimeline MultiaddrFilter NewStreamOptions NodeInfo Peer PeerData PeerDiscovery PeerDiscoveryEvents PeerDiscoveryProvider PeerId PeerInfo PeerQuery PeerQueryFilter PeerQueryOrder PeerRouting PeerRoutingProvider PeerStore PeerStreamEvents PeerStreams PeerUpdate PendingDial PrivateKey PubSub PubSubEvents PubSubInit PubSubRPC PubSubRPCMessage PubSubRPCSubscription PublicKey PublishResult RSAPeerId Record RoutingOptions Secp256k1PeerId SecuredConnection SignedMessage SignedPeerRecord Startable StopTimer Stream StreamHandler StreamHandlerOptions StreamHandlerRecord StreamMuxer StreamMuxerFactory StreamMuxerInit StreamTimeline SubscriptionChangeData Tag TagOptions TopicValidatorFn Topology TopologyFilter Transport TypedEventTarget UnsignedMessage Upgrader UpgraderOptions

Type Aliases

CalculateMetric ConnectionStatus Direction EventHandler KeyType Libp2pStatus Message PeerIdType PendingDialStatus ReadStatus RecursivePartial ServiceMap SignaturePolicy StreamStatus WriteStatus

Variables

CustomEvent ERR_INVALID_MESSAGE ERR_INVALID_PARAMETERS ERR_NOT_FOUND ERR_TIMEOUT Ed25519 KEEP_ALIVE RSA StrictNoSign StrictSign connectionSymbol contentRoutingSymbol peerDiscoverySymbol peerIdSymbol peerRoutingSymbol secp256k1 transportSymbol

Functions

isConnection isPeerId isStartable isTransport setMaxListeners start stop