Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libp2p/js-libp2p-mplex
JavaScript implementation of https://github.com/libp2p/mplex
https://github.com/libp2p/js-libp2p-mplex
Last synced: 3 months ago
JSON representation
JavaScript implementation of https://github.com/libp2p/mplex
- Host: GitHub
- URL: https://github.com/libp2p/js-libp2p-mplex
- Owner: libp2p
- License: other
- Archived: true
- Created: 2016-03-06T23:17:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T15:43:00.000Z (over 1 year ago)
- Last Synced: 2024-05-11T08:20:21.347Z (7 months ago)
- Language: TypeScript
- Homepage: https://libp2p.io
- Size: 1.85 MB
- Stars: 51
- Watchers: 20
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📁 Archived - this module has been merged into [js-libp2p](https://github.com/libp2p/js-libp2p/tree/master/packages/stream-multiplexer-mplex)
# @libp2p/mplex
[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-mplex.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-mplex)
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-mplex/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-mplex/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)> JavaScript implementation of
## Table of contents
- [Install](#install)
- [Browser `` tag](#browser-script-tag)
- [Usage](#usage)
- [API Docs](#api-docs)
- [License](#license)
- [Contribution](#contribution)## Install
```console
$ npm i @libp2p/mplex
```### Browser `<script>` tag
Loading this module through a script tag will make it's exports available as `Libp2pMplex` in the global namespace.
```html
<script src="https://unpkg.com/@libp2p/mplex/dist/index.min.js">
```[![](https://github.com/libp2p/interface-stream-muxer/raw/master/img/badge.png)](https://github.com/libp2p/interface-stream-muxer)
## Usage
```js
import { mplex } from '@libp2p/mplex'
import { pipe } from 'it-pipe'const factory = mplex()
const muxer = factory.createStreamMuxer(components, {
onStream: stream => { // Receive a duplex stream from the remote
// ...receive data from the remote and optionally send data back
},
onStreamEnd: stream => {
// ...handle any tracking you may need of stream closures
}
})pipe(conn, muxer, conn) // conn is duplex connection to another peer
const stream = muxer.newStream() // Create a new duplex stream to the remote
// Use the duplex stream to send some data to the remote...
pipe([1, 2, 3], stream)
```## API Docs
-
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-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.