fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-03-25 05:11:12 +00:00
Code Issues Projects Releases Wiki Activity

rename, following https://github.com/diasdavid/node-ipfs-swarm/issues/8#issuecomment-140929746

Browse Source
This commit is contained in:
David Dias 2015-09-17 02:44:07 +01:00
parent e1b7badc2d
commit 3b0a98ccf0
5 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,11 +1,11 @@
abstract-transport
abstract-connection
==================
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
> A test suite and interface you can use to implement a transport. A transport is understood as something that offers mechanism for writing and reading data, back pressure, half and full duplex streams. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer.
> A test suite and interface you can use to implement a connection. A connection is understood as something that offers mechanism for writing and reading data, back pressure, half and full duplex streams. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer.
The primary goal of module is to enable developers to pick, swap or upgrade their transport without loosing the same API expectations and mechanisms such as back pressure and the hability to half close a stream.
The primary goal of module is to enable developers to pick, swap or upgrade their connection without loosing the same API expectations and mechanisms such as back pressure and the hability to half close a connection.
Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.
@ -22,7 +22,7 @@ The API is presented with both Node.js and Go primitives, however, there is not
Include this badge in your readme if you make a module that is compatible with the abstract-connection API. You can validate this by running the tests.
![](https://raw.githubusercontent.com/diasdavid/abstract-transport/master/img/badge.png)
![](https://raw.githubusercontent.com/diasdavid/abstract-connection/master/img/badge.png)
# How to use the battery of tests
@ -30,12 +30,12 @@ Include this badge in your readme if you make a module that is compatible with t
```
var tape = require('tape')
var tests = require('abstract-transport/tests')
var YourTransportHandler = require('../src')
var tests = require('abstract-connection/tests')
var YourConnectionHandler = require('../src')
var common = {
setup: function (t, cb) {
cb(null, YourTransportHandler)
cb(null, YourConnectionHandler)
},
teardown: function (t, cb) {
cb()

BIN
img/badge.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.1 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

BIN
img/badge.sketch
View File

Binary file not shown.

8
img/badge.svg
View File

File diff suppressed because one or more lines are too long
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 42 KiB

10
package.json
View File

@ -1,10 +1,10 @@
{
"name": "abstract-transport",
"name": "abstract-connection",
"version": "0.0.0",
"description": "A test suite and interface you can use to implement a transport interface.",
"description": "A test suite and interface you can use to implement a connection interface.",
"repository": {
"type": "git",
"url": "https://github.com/diasdavid/abstract-transport.git"
"url": "https://github.com/diasdavid/abstract-connection.git"
},
"keywords": [
"IPFS"
@ -12,7 +12,7 @@
"author": "David Dias <daviddias@ipfs.io>",
"license": "MIT",
"bugs": {
"url": "https://github.com/diasdavid/abstract-transport/issues"
"url": "https://github.com/diasdavid/abstract-connection/issues"
},
"homepage": "https://github.com/diasdavid/abstract-transport"
"homepage": "https://github.com/diasdavid/abstract-connection"
}