fluencelabs/js-libp2p-tcp
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-tcp synced 2025-04-25 18:22:30 +00:00
Code Issues Projects Releases Wiki Activity

Fixes README example & grammar.

Browse Source
This commit is contained in:
Stephen Whitmore 2016-04-22 14:14:07 -07:00
parent ce6edb05a2
commit 69068f5da4
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -17,7 +17,7 @@ js-libp2p-tcp
## Description ## Description
`libp2p-tcp` in Node.js is a very thin shim that adds the support to dial to a `libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a
`multiaddr`. This small shim will enable libp2p to use other different `multiaddr`. This small shim will enable libp2p to use other different
transports. transports.
@ -41,7 +41,7 @@ tcp.createListener([mh1, mh2], function handler (socket) {
const client = tcp.dial(mh1) const client = tcp.dial(mh1)
client.pipe(process.stdout) client.pipe(process.stdout)
client.on('end', () => { client.on('end', () => {
tcp.close(function(){}) tcp.close()
}) })
}) })
@ -71,14 +71,14 @@ const Tcp = require('libp2p-tcp')
### var tcp = new Tcp() ### var tcp = new Tcp()
Creates a new TCP object. This does nothing on its own but provide access to Creates a new TCP object. This does nothing on its own, but provides access to
`dial` and `createListener`. `dial` and `createListener`.
### tcp.createListener(multiaddrs, handler, callback) ### tcp.createListener(multiaddrs, handler, ready)
Creates TCP servers that listen on the addresses described in the array Creates TCP servers that listen on the addresses described in the array
`multiaddrs`. Each connection will call `handler` with a connection stream. `multiaddrs`. Each connection will call `handler` with a connection stream.
`callback` is called once all servers are listening. `ready` is called once all servers are listening.
### tcp.dial(multiaddr, options={}) ### tcp.dial(multiaddr, options={})