2019-10-20 11:57:13 +02:00
|
|
|
<!doctype html>
|
2020-12-10 14:07:32 +01:00
|
|
|
<html class="default no-js">
|
2019-10-20 11:57:13 +02:00
|
|
|
<head>
|
2020-12-10 14:07:32 +01:00
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
2021-04-07 09:44:15 +02:00
|
|
|
<title>libp2p-interfaces - v0.9.0</title>
|
|
|
|
|
<meta name="description" content="Documentation for libp2p-interfaces - v0.9.0">
|
2020-12-10 14:07:32 +01:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<link rel="stylesheet" href="assets/css/main.css">
|
2021-04-07 09:44:15 +02:00
|
|
|
<script async src="assets/js/search.js" id="search-script"></script>
|
2019-10-20 11:57:13 +02:00
|
|
|
</head>
|
2020-12-10 14:07:32 +01:00
|
|
|
<body>
|
|
|
|
|
<header>
|
|
|
|
|
<div class="tsd-page-toolbar">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="table-wrap">
|
|
|
|
|
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
|
|
|
|
|
<div class="field">
|
2021-04-07 09:44:15 +02:00
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
2020-12-10 14:07:32 +01:00
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
|
|
</div>
|
|
|
|
|
<ul class="results">
|
|
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
|
|
</ul>
|
2021-04-07 09:44:15 +02:00
|
|
|
<a href="index.html" class="title">libp2p-interfaces - v0.9.0</a>
|
2020-12-10 14:07:32 +01:00
|
|
|
</div>
|
|
|
|
|
<div class="table-cell" id="tsd-widgets">
|
2021-04-07 09:44:15 +02:00
|
|
|
<div id="tsd-filter">
|
|
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
|
|
<div class="tsd-filter-group">
|
|
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
|
|
<ul class="tsd-select-list">
|
|
|
|
|
<li data-value="public">Public</li>
|
|
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
2020-12-10 14:07:32 +01:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tsd-page-title">
|
|
|
|
|
<div class="container">
|
2021-04-07 09:44:15 +02:00
|
|
|
<h1>libp2p-interfaces - v0.9.0</h1>
|
2020-12-10 14:07:32 +01:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</header>
|
|
|
|
|
<div class="container container-main">
|
|
|
|
|
<div class="row">
|
|
|
|
|
<div class="col-8 col-content">
|
|
|
|
|
<div class="tsd-panel tsd-typography">
|
|
|
|
|
<a href="#js-libp2p-interfaces" id="js-libp2p-interfaces" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h1>JS libp2p Interfaces</h1>
|
|
|
|
|
</a>
|
|
|
|
|
<p><a href="http://protocol.ai"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" alt=""></a>
|
|
|
|
|
<a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" alt=""></a>
|
|
|
|
|
<a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" alt=""></a>
|
2021-01-20 10:19:55 +01:00
|
|
|
<a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" alt=""></a>
|
|
|
|
|
<a href="https://codecov.io/gh/libp2p/js-libp2p-interfaces"><img src="https://img.shields.io/codecov/c/github/libp2p/js-libp2p-interfaces.svg?style=flat-square" alt="codecov"></a>
|
|
|
|
|
<a href="https://github.com/libp2p/js-libp2p-interfaces/actions?query=branch%3Amaster+workflow%3Aci+"><img src="https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/ci?label=ci&style=flat-square" alt="GitHub Workflow Status"></a></p>
|
2020-12-10 14:07:32 +01:00
|
|
|
<blockquote>
|
|
|
|
|
<p>Contains test suites and interfaces you can use to implement the various components of libp2p.</p>
|
|
|
|
|
</blockquote>
|
|
|
|
|
<a href="#lead-maintainer" id="lead-maintainer" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Lead Maintainer</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p><a href="https://github.com/jacobheun">Jacob Heun</a>.</p>
|
|
|
|
|
<a href="#interfaces" id="interfaces" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Interfaces</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="./src/connection">Connection</a></li>
|
|
|
|
|
<li><a href="./src/content-routing">Content Routing</a></li>
|
|
|
|
|
<li><a href="./src/crypto">Crypto</a></li>
|
|
|
|
|
<li><a href="./src/peer-discovery">Peer Discovery</a></li>
|
|
|
|
|
<li><a href="./src/peer-routing">Peer Routing</a></li>
|
|
|
|
|
<li><a href="./src/pubsub">Pubsub</a></li>
|
|
|
|
|
<li><a href="./src/record">Record</a></li>
|
|
|
|
|
<li><a href="./src/stream-muxer">Stream Muxer</a></li>
|
|
|
|
|
<li><a href="./src/topology">Topology</a></li>
|
|
|
|
|
<li><a href="./src/transport">Transport</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a href="#origin-repositories" id="origin-repositories" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h3>Origin Repositories</h3>
|
|
|
|
|
</a>
|
|
|
|
|
<p>For posterity, here are links to the original repositories for each of the interfaces (if they had one).</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-connection">Connection</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-content-routing">Content Routing</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-peer-discovery">Peer Discovery</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-peer-routing">Peer Routing</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/js-libp2p-pubsub">Pubsub</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-stream-muxer">Stream Muxer</a></li>
|
|
|
|
|
<li><a href="https://github.com/libp2p/interface-transport">Transport</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a href="#contribute" id="contribute" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Contribute</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>Feel free to join in. All welcome. Open an <a href="https://github.com/libp2p/js-interfaces/issues">issue</a>!</p>
|
|
|
|
|
<p>This repository falls under the IPFS <a href="https://github.com/ipfs/community/blob/master/code-of-conduct.md">Code of Conduct</a>.</p>
|
|
|
|
|
<p><a href="https://github.com/ipfs/community/blob/master/contributing.md"><img src="https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif" alt=""></a></p>
|
|
|
|
|
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>License</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>MIT - Protocol Labs 2019</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
|
|
<nav class="tsd-navigation primary">
|
|
|
|
|
<ul>
|
2021-04-07 09:44:15 +02:00
|
|
|
<li class=" ">
|
|
|
|
|
<a href="modules.html">Exports</a>
|
2020-12-10 14:07:32 +01:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
|
|
<ul class="before-current">
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer>
|
|
|
|
|
<div class="container">
|
|
|
|
|
<h2>Legend</h2>
|
|
|
|
|
<div class="tsd-legend-group">
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
<div class="overlay"></div>
|
|
|
|
|
<script src="assets/js/main.js"></script>
|
2019-10-20 11:57:13 +02:00
|
|
|
</body>
|
2020-12-10 14:07:32 +01:00
|
|
|
</html>
|
