Return object wrapping path+node on ipfs.files.add

Author: hackergrrl

README.md

@@ -79,19 +79,25 @@ Where `data` may be
 
 `callback` must follow `function (err, res) {}` signature, where `err` is an
 error if the operation was not successful. `res` will be an array of
-[DAGNode][]s.
+
+```js
+{
+  path: '/tmp/myfile.txt',
+  node: DAGNode
+}
+```
 
 If no `callback` is passed, a promise is returned.
 
 ```js
 var files = [
   {
     path: '/tmp/myfile.txt',
-    content: fs.createReadStream('/tmp/myfile.txt')
+    content: (Buffer or Readable stream)
   }
 ]
-ipfs.files.add(files, function (err, dagNodes) {
-  // 'res' will be an array of DAGNodes
+ipfs.files.add(files, function (err, files) {
+  // 'files' will be an array of objects
 })
 ```
 
@@ -122,8 +128,12 @@ If no `callback` is passed, a promise is returned.
 
 ```js
 ipfs.files.createAddStream(function (err, stream) {
-  stream.on('data', function (dagNode) {
-    // ...
+  stream.on('data', function (file) {
+    // 'file' will be of the form
+    // {
+    //   path: '/tmp/myfile.txt',
+    //   node: DAGNode
+    // }
   })
 
   stream.write({path: <path to file>, content: <buffer or readable stream>})

test/files.js

@@ -50,9 +50,10 @@ module.exports = (common) => {
       ipfs.files.add(arr, (err, res) => {
         expect(err).to.not.exist
         expect(res).to.be.length(1)
-        expect(res[0].size()).to.equal(17)
+        expect(res[0].path).to.equal('data.txt')
+        expect(res[0].node.size()).to.equal(17)
         const mh = 'QmVv4Wz46JaZJeH5PMV4LGbRiiMKEmszPYY3g6fjGnVXBS'
-        expect(bs58.encode(res[0].multihash()).toString()).to.equal(mh)
+        expect(bs58.encode(res[0].node.multihash()).toString()).to.equal(mh)
         done()
       })
     })
@@ -69,9 +70,10 @@ module.exports = (common) => {
         expect(err).to.not.exist
 
         const added = res[0] != null ? res[0] : res
-        const mh = bs58.encode(added.multihash()).toString()
+        const mh = bs58.encode(added.node.multihash()).toString()
         expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
-        expect(added.links).to.have.length(0)
+        expect(added.path).to.equal('testfile.txt')
+        expect(added.node.links).to.have.length(0)
         done()
       })
     })
@@ -82,9 +84,10 @@ module.exports = (common) => {
         expect(err).to.not.exist
 
         expect(res).to.have.length(1)
-        const mh = bs58.encode(res[0].multihash()).toString()
+        const mh = bs58.encode(res[0].node.multihash()).toString()
         expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
-        expect(res[0].links).to.have.length(0)
+        expect(res[0].path).to.equal(mh)
+        expect(res[0].node.links).to.have.length(0)
         done()
       })
     })
@@ -98,9 +101,9 @@ module.exports = (common) => {
         expect(err).to.not.exist
 
         expect(res).to.have.length(1)
-        const mh = bs58.encode(res[0].multihash()).toString()
+        const mh = bs58.encode(res[0].node.multihash()).toString()
         expect(mh).to.equal('Qmcx5werSWQPdrGVap7LARHB4QUSPRPJwxhFuHvdoXqQXT')
-        expect(res[0].links).to.have.length(58)
+        expect(res[0].node.links).to.have.length(58)
         done()
       })
     })
@@ -130,9 +133,10 @@ module.exports = (common) => {
         expect(err).to.not.exist
 
         const added = res[res.length - 1]
-        const mh = bs58.encode(added.multihash()).toString()
+        const mh = bs58.encode(added.node.multihash()).toString()
         expect(mh).to.equal('QmW2d9LPX4KxpeLDyH3tqYnHrkRMHx8xMQp9cpXEEj2DyR')
-        expect(added.links).to.have.length(5)
+        expect(added.path).to.equal('test-folder')
+        expect(added.node.links).to.have.length(5)
         done()
       })
     })
@@ -143,9 +147,10 @@ module.exports = (common) => {
         return ipfs.files.add(buf)
           .then((res) => {
             const added = res[0] != null ? res[0] : res
-            const mh = bs58.encode(added.multihash()).toString()
+            const mh = bs58.encode(added.node.multihash()).toString()
             expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
-            expect(added.links).to.have.length(0)
+            expect(added.path).to.equal(mh)
+            expect(added.node.links).to.have.length(0)
           })
           .catch((err) => {
             expect(err).to.not.exist