cr - round1

Author: dignifiedquire

README.md

@@ -1,20 +1,60 @@
-peer-info JavaScript implementation
-===================================
+# js-peer-info
 
 [![](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)
-[![Build Status](https://travis-ci.org/diasdavid/js-peer-info.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-peer-info)
-[![Coverage Status](https://coveralls.io/repos/github/diasdavid/js-peer-info/badge.svg?branch=master)](https://coveralls.io/github/diasdavid/js-peer-info?branch=master)
-[![Dependency Status](https://david-dm.org/diasdavid/js-peer-info.svg?style=flat-square)](https://david-dm.org/diasdavid/js-peer-info)
+[![Build Status](https://travis-ci.org/multiformats/js-peer-info.svg?style=flat-square)](https://travis-ci.org/multiformats/js-peer-info)
+[![Coverage Status](https://coveralls.io/repos/github/multiformats/js-peer-info/badge.svg?branch=master)](https://coveralls.io/github/multiformats/js-peer-info?branch=master)
+[![Dependency Status](https://david-dm.org/multiformats/js-peer-info.svg?style=flat-square)](https://david-dm.org/multiformats/js-peer-info)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 
 > A PeerInfo object contains information about a
 > [PeerID](https://github.com/libp2p/js-peer-id) and its
 > [multiaddrs](https://github.com/libp2p/js-multiaddr). This module is used by
 > [IPFS](https://github.com/ipfs/ipfs) and
 > [libp2p](https://github.com/libp2p/js-libp2p).
 
-# Example
+- [Installation](#installation)
+  - [npm](#npm)
+  - [Node.JS, Browserify, Webpack](#nodejs-browserify-webpack)
+  - [Browser: `<script>` Tag](#browser-script-tag)
+- [Usage](#usage)
+- [API](#api)
+  - [`PeerInfo.create([id, ] callback)`](#peerinfocreateid-callback)
+  - [`new PeerInfo(id)`](#new-peerinfoid)
+  - [`multiaddrs`](#multiaddrs)
+  - [`multiaddr.add(addr)`](#multiaddraddaddr)
+  - [`multiaddr.addSafe(addr)`](#multiaddraddsafeaddr)
+  - [`multiaddr.rm(addr)`](#multiaddrrmaddr)
+  - [`multiaddr.replace(existing, fresh)`](#multiaddrreplaceexisting-fresh)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Installation
+
+### npm
+
+```sh
+> npm i peer-info
+```
+
+### Node.JS, Browserify, Webpack
+
+```js
+const PeerInfo = require('peer-info')
+```
+
+### Browser: `<script>` Tag
+
+Loading this module through a script tag will make the `PeerInfo` obj available in the global namespace.
+
+```html
+<script src="https://unpkg.com/peer-info/dist/index.min.js"></script>
+<!-- OR -->
+<script src="https://unpkg.com/peer-info/dist/index.js"></script>
+```
+
+## Usage
 
 ```js
 const PeerInfo = require('peer-info')
@@ -32,31 +72,41 @@ peer.multiaddr.add(multiaddr('/ip4/1.2.3.4/udp/8001'))
 peer.multiaddr.add(multiaddr('/sonic/bfsk/697/1209'))
 ```
 
-# API
+## API
 
 ```js
 const PeerInfo = require('peer-info')
 ```
 
-## const peer = new PeerInfo()
+### `PeerInfo.create([id, ] callback)`
+
+- `id: PeerID`, optional
+- `callback: Function`
+
+Creates a new PeerInfo instance and if no `id` is passed it
+generates a new underlying [PeerID](https://github.com/libp2p/js-peer-id)
+for it.
 
-Creates a new PeerInfo instance and also generates a new underlying
-[PeerID](https://github.com/libp2p/js-peer-id) for it.
+### `new PeerInfo(id)`
 
-## const peer = new PeerInfo(peerId)
+- `id: PeerID`
 
 Creates a new PeerInfo instance from an existing PeerID.
 
-## peer.multiaddrs
+### `multiaddrs`
 
 A list of multiaddresses instances that `peer` can be reached at.
 
-## peer.multiaddr.add(addr)
+### `multiaddr.add(addr)`
+
+- `addr: Multiaddr`
 
 Adds a new multiaddress that `peer` can be reached at. `addr` is an instance of
 a [multiaddr](https://github.com/libp2p/js-multiaddr).
 
-## peer.multiaddr.addSafe(addr)
+### `multiaddr.addSafe(addr)`
+
+- `addr: Multiaddr`
 
 The `addSafe` call, in comparison to `add`, will only add the multiaddr to
 `multiaddrs` if the same multiaddr tries to be added twice.
@@ -67,40 +117,26 @@ peers which will not provide a useful multiaddr to be shared to the rest of the
 network (e.g. a multiaddr referring to a peer inside a LAN being shared to the
 outside world).
 
-## peer.multiaddr.rm(addr)
+### `multiaddr.rm(addr)`
+
+- `addr: Multiaddr`
 
 Removes a multiaddress instance `addr` from `peer`.
 
-## peer.multiaddr.replace(existing, fresh)
+### `multiaddr.replace(existing, fresh)`
+
+- `existing: Multiaddr`
+- `fresh: Multiaddr`
 
 Removes the array of multiaddresses `existing` from `peer`, and adds the array
 of multiaddresses `fresh`.
 
+## Contribute
 
-# Installation
-
-## npm
-
-```sh
-> npm i peer-info
-```
-
-## Node.JS, Browserify, Webpack
-
-```JavaScript
-var PeerInfo = require('peer-info')
-```
-
-## Browser: `<script>` Tag
-
-Loading this module through a script tag will make the `PeerInfo` obj available in the global namespace.
+PRs accepted.
 
-```html
-<script src="https://unpkg.com/peer-info/dist/index.min.js"></script>
-<!-- OR -->
-<script src="https://unpkg.com/peer-info/dist/index.js"></script>
-```
+Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
 
-# License
+## License
 
-MIT
+[MIT © David Dias](LICENSE)

src/index.js

@@ -3,7 +3,7 @@
 const Id = require('peer-id')
 const multiaddr = require('multiaddr')
 
-exports = module.exports = Peer
+exports = module.exports = PeerInfo
 
 function ensureMultiaddr (addr) {
   if (multiaddr.isMultiaddr(addr)) {
@@ -14,9 +14,9 @@ function ensureMultiaddr (addr) {
 }
 
 // Peer represents a peer on the IPFS network
-function Peer (peerId) {
-  if (!(this instanceof Peer)) {
-    return new Peer(peerId)
+function PeerInfo (peerId) {
+  if (!(this instanceof PeerInfo)) {
+    return new PeerInfo(peerId)
   }
 
   if (!peerId) {
@@ -92,12 +92,20 @@ function Peer (peerId) {
   // look at https://github.com/whyrusleeping/js-mafmt/blob/master/src/index.js
 }
 
-Peer.create = (cb) => {
-  Id.create((err, key) => {
-    if (err) {
-      return cb(err)
-    }
+PeerInfo.create = (id, callback) => {
+  if (typeof id === 'function') {
+    callback = id
+    id = null
+
+    Id.create((err, id) => {
+      if (err) {
+        return callback(err)
+      }
+
+      callback(null, new PeerInfo(id))
+    })
+    return
+  }
 
-    cb(null, new Peer(key))
-  })
+  callback(null, new PeerInfo(id))
 }

test/peer-info.spec.js renamed to test/index.spec.js

@@ -47,6 +47,18 @@ describe('peer-info', () => {
     })
   })
 
+  it('PeerInfo.create with existing id', (done) => {
+    PeerId.create((err, id) => {
+      expect(err).to.not.exist
+      PeerInfo.create(id, (err, pi) => {
+        expect(err).to.not.exist
+        expect(pi.id).to.exist
+        expect(pi.id).to.deep.equal(id)
+        done()
+      })
+    })
+  })
+
   it('add multiaddr', () => {
     const mh = Multiaddr('/ip4/127.0.0.1/tcp/5001')
     pi.multiaddr.add(mh)