feat: add toString function

This makes stringifying a CID super easy like `${cid}` or `cid+''`. License: MIT Signed-off-by: Alan Shaw <[email protected]>
multiformats · Sep 11, 2018 · f47e68c · f47e68c
1 parent 4027108
commit f47e68c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/src/index.js b/src/index.js
@@ -186,6 +186,10 @@ class CID {
     }
   }
 
+  toString (base) {
+    return this.toBaseEncodedString(base)
+  }
+
   /**
    * Serialize to a plain object.
    *

diff --git a/test/index.spec.js b/test/index.spec.js
@@ -199,6 +199,19 @@ describe('CID', () => {
         CID.isCID(Buffer.from('hello world'))
       ).to.equal(false)
     })
+
+    it('.toString() outputs default base encoded CID', () => {
+      const mhStr = 'QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n'
+      const cid = new CID(mhStr)
+      expect(`${cid}`).to.equal(mhStr)
+    })
+
+    it('.toString(base) outputs base encoded CID', () => {
+      const b58v1Str = 'zdj7Wd8AMwqnhJGQCbFxBVodGSBG84TM7Hs1rcJuQMwTyfEDS'
+      const b32v1Str = 'bafybeidskjjd4zmr7oh6ku6wp72vvbxyibcli2r6if3ocdcy7jjjusvl2u'
+      const cid = new CID(b58v1Str)
+      expect(cid.toString('base32')).to.equal(b32v1Str)
+    })
   })
 
   describe('throws on invalid inputs', () => {