test: pin.ls with multiple CIDs (#563)

* test: pin.ls with multiple CIDs

* docs: document pin.ls CID parameter properly

Author: Alan Shaw

SPEC/PIN.md

@@ -48,11 +48,11 @@ A great source of [examples][] can be found in the tests for this API.
 
 > List all the objects pinned to local storage or under a specific hash.
 
-##### `ipfs.pin.ls([hash], [options])`
+##### `ipfs.pin.ls([cid], [options])`
 
 Where:
 
-- `hash` is an IPFS multihash.
+- `cid` - a [CID][cid] instance or CID as a string or an array of CIDs.
 - `options` is an object that can contain the following keys:
   - 'type' - Return also the type of pin (direct, indirect or recursive)
 
@@ -107,3 +107,4 @@ console.log(pinset)
 A great source of [examples][] can be found in the tests for this API.
 
 [examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/pin
+[cid]: https://www.npmjs.com/package/cids

src/pin/ls.js

@@ -140,5 +140,12 @@ module.exports = (createCommon, options) => {
         hash: fixtures.files[0].cid
       }])
     })
+
+    it('should list pins for multiple CIDs', async () => {
+      const pinset = await ipfs.pin.ls([fixtures.files[0].cid, fixtures.files[1].cid])
+      const cids = pinset.map(({ hash }) => hash)
+      expect(cids).to.include(fixtures.files[0].cid)
+      expect(cids).to.include(fixtures.files[1].cid)
+    })
   })
 }