docs: fix API docs

This commit is contained in:
David Dias 2017-07-09 11:42:11 +01:00
parent c1a471793d
commit c23f147bda

View File

@ -115,7 +115,7 @@ class Node extends libp2p {
]
},
discovery: [
new MulticastDNS(peerInfo, 'your-identifier')
new MulticastDNS(peerInfo)
],
// DHT is passed as its own enabling PeerRouting, ContentRouting and DHT itself components
dht: DHT
@ -182,19 +182,6 @@ class Node extends libp2p {
- `key`: Buffer
#### `libp2p.dht.put(key, value, callback)`
- `key`: Buffer
- `value`: Buffer
#### `libp2p.dht.get(key, callback)`
- `key`: Buffer
#### `libp2p.dht.getMany(key, nVals, callback)`
- `key`: Buffer
- `nVals`: Number
#### `libp2p.handle(protocol, handlerFunc [, matchFunc])`
@ -228,7 +215,7 @@ class Node extends libp2p {
- `peer`: instance of [PeerInfo][]
#### `libp2p.isOn()`
#### `libp2p.isStarted()`
> Check if libp2p is started
@ -246,6 +233,24 @@ class Node extends libp2p {
---------------------
`DHT methods exposed`
#### `libp2p.dht.put(key, value, callback)`
- `key`: Buffer
- `value`: Buffer
#### `libp2p.dht.get(key, callback)`
- `key`: Buffer
#### `libp2p.dht.getMany(key, nVals, callback)`
- `key`: Buffer
- `nVals`: Number
---------------------
`SOON™`
#### `libp2p.findPeers`