chore: release version v0.12.0

feat: add class-is module

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="0.12.0"></a>
+# [0.12.0](https://github.com/libp2p/js-peer-id/compare/v0.11.0...v0.12.0) (2018-10-18)
+
+
+### Bug Fixes
+
+* add peerIdWithIs to the API functions using the instance ([2e5e666](https://github.com/libp2p/js-peer-id/commit/2e5e666))
+
+
+### Features
+
+* add class-is module ([6513a02](https://github.com/libp2p/js-peer-id/commit/6513a02))
+
+
+
 <a name="0.11.0"></a>
 # [0.11.0](https://github.com/libp2p/js-peer-id/compare/v0.10.7...v0.11.0) (2018-07-02)
 

README.md

@@ -144,6 +144,7 @@ Creates a Peer ID from hex string representing the key's multihash.
 Creates a Peer ID from a buffer representing the key's multihash.
 
 ### `createFromB58String(str)`
+
 Creates a Peer ID from a Base58 string representing the key's multihash.
 
 ### `createFromPubKey(pubKey)`
@@ -161,8 +162,8 @@ Creates a Peer ID from a buffer containing a private key.
 ### `createFromJSON(obj)`
 
 - `obj.id: String` - The multihash encoded in `base58`
-- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
-- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
+- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
+- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
 
 ## Export
 
@@ -198,10 +199,9 @@ Returns an `obj` of the form
 - `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
 - `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
 
-
 ### `toPrint()`
 
-Returns the Peer ID as a printable string.
+Returns the Peer ID as a printable string without the `Qm` prefix.
 
 Example: `<peer.ID xxxxxx>`
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "peer-id",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "IPFS Peer Id implementation in Node.js",
   "leadMaintainer": "Pedro Teixeira <i@pgte.me>",
   "main": "src/index.js",
@@ -39,6 +39,7 @@
   },
   "dependencies": {
     "async": "^2.6.1",
+    "class-is": "^1.1.0",
     "libp2p-crypto": "~0.13.0",
     "lodash": "^4.17.10",
     "multihashes": "~0.4.13"
@@ -53,10 +54,12 @@
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Maciej Krüger <mkg20001@gmail.com>",
     "Michael Garvin <gar+gh@danger.computer>",
+    "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Richard Schneider <makaretu@gmail.com>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
     "Yahya <ya7yaz@gmail.com>",
     "greenkeeperio-bot <support@greenkeeper.io>",
     "nginnever <ginneversource@gmail.com>",

src/index.js

@@ -8,6 +8,7 @@ const mh = require('multihashes')
 const crypto = require('libp2p-crypto')
 const assert = require('assert')
 const waterfall = require('async/waterfall')
+const withIs = require('class-is')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
@@ -132,7 +133,9 @@ class PeerId {
   }
 }
 
-exports = module.exports = PeerId
+const PeerIdWithIs = withIs(PeerId, { className: 'PeerId', symbolName: '@libp2p/js-peer-id/PeerId' })
+
+exports = module.exports = PeerIdWithIs
 
 // generation
 exports.create = function (opts, callback) {
@@ -153,20 +156,20 @@ exports.create = function (opts, callback) {
       return callback(err)
     }
 
-    callback(null, new PeerId(digest, privKey))
+    callback(null, new PeerIdWithIs(digest, privKey))
   })
 }
 
 exports.createFromHexString = function (str) {
-  return new PeerId(mh.fromHexString(str))
+  return new PeerIdWithIs(mh.fromHexString(str))
 }
 
 exports.createFromBytes = function (buf) {
-  return new PeerId(buf)
+  return new PeerIdWithIs(buf)
 }
 
 exports.createFromB58String = function (str) {
-  return new PeerId(mh.fromB58String(str))
+  return new PeerIdWithIs(mh.fromB58String(str))
 }
 
 // Public Key input will be a buffer
@@ -195,7 +198,7 @@ exports.createFromPubKey = function (key, callback) {
       return callback(err)
     }
 
-    callback(null, new PeerId(digest, null, pubKey))
+    callback(null, new PeerIdWithIs(digest, null, pubKey))
   })
 }
 
@@ -227,7 +230,7 @@ exports.createFromPrivKey = function (key, callback) {
       return callback(err)
     }
 
-    callback(null, new PeerId(digest, privKey, privKey.public))
+    callback(null, new PeerIdWithIs(digest, privKey, privKey.public))
   })
 }
 
@@ -278,10 +281,10 @@ exports.createFromJSON = function (obj, callback) {
         return callback(new Error('Id and private key do not match'))
       }
 
-      callback(null, new PeerId(id, priv, pub))
+      callback(null, new PeerIdWithIs(id, priv, pub))
     })
   } else {
-    callback(null, new PeerId(id, null, pub))
+    callback(null, new PeerIdWithIs(id, null, pub))
   }
 }