Rename "stream" to "content" in tuples.

Author: hackergrrl

README.md

@@ -47,8 +47,8 @@ const res = []
 
 const rs = fs.createReadStream(file)
 const rs2 = fs.createReadStream(file2)
-const input = {path: /tmp/foo/bar, stream: rs}
-const input2 = {path: /tmp/foo/quxx, stream: rs2}
+const input = {path: /tmp/foo/bar, content: rs}
+const input2 = {path: /tmp/foo/quxx, content: rs2}
 
 // Listen for the data event from the importer stream
 
@@ -138,7 +138,7 @@ exportEvent.on('data', (result) => {
 const Importer = require('ipfs-unixfs-engine').exporter
 ```
 
-The exporter is a readable stream in object mode that returns an object ```{ stream: stream, path: 'path' }``` by the multihash of the file from the dag service.
+The exporter is a readable stream in object mode that returns an object ```{ content: stream, path: 'path' }``` by the multihash of the file from the dag service.
 
 
 ## install

src/exporter.js

@@ -42,7 +42,7 @@ function Exporter (hash, dagService, options) {
         rs.push(unmarshaledData.data)
         rs.push(null)
       }
-      this.push({ stream: rs, path: name })
+      this.push({ content: rs, path: name })
       callback()
       return
     } else {
@@ -75,7 +75,7 @@ function Exporter (hash, dagService, options) {
           return
         })
       }
-      this.push({ stream: rs, path: name })
+      this.push({ content: rs, path: name })
       callback()
       return
     }
@@ -97,7 +97,7 @@ function Exporter (hash, dagService, options) {
         rs.push(node.data)
         rs.push(null)
       }
-      this.push({stream: null, path: name})
+      this.push({content: null, path: name})
       callback()
       return
     } else {

src/importer.js

@@ -36,7 +36,7 @@ function Importer (dagService, options) {
   this._write = (fl, enc, next) => {
     this.read()
     counter++
-    if (!fl.stream) {
+    if (!fl.content) {
       // 1. create the empty dir dag node
       // 2. write it to the dag store
       // 3. add to the files array {path: <>, hash: <>}
@@ -64,7 +64,7 @@ function Importer (dagService, options) {
     }
 
     const leaves = []
-    fl.stream
+    fl.content
       .pipe(fsc(CHUNK_SIZE))
       .pipe(through2((chunk, enc, cb) => {
         // 1. create the unixfs merkledag node

test/test-exporter.js

@@ -33,7 +33,7 @@ module.exports = function (repo) {
         expect(err).to.not.exist
         const testExport = exporter(hash, ds)
         testExport.on('data', (file) => {
-          file.stream.pipe(bl((err, bldata) => {
+          file.content.pipe(bl((err, bldata) => {
             expect(err).to.not.exist
             expect(bldata).to.deep.equal(unmarsh.data)
             done()
@@ -48,7 +48,7 @@ module.exports = function (repo) {
       const ds = new DAGService(bs)
       const testExport = exporter(hash, ds)
       testExport.on('data', (file) => {
-        file.stream.pipe(bl((err, bldata) => {
+        file.content.pipe(bl((err, bldata) => {
           expect(bldata).to.deep.equal(bigFile)
           expect(err).to.not.exist
           done()
@@ -63,7 +63,7 @@ module.exports = function (repo) {
       const testExport = exporter(hash, ds)
       testExport.on('data', (file) => {
         expect(file.path).to.equal('QmRQgufjp9vLE8XK2LGKZSsPCFCF6e4iynCQtNB5X2HBKE')
-        file.stream.pipe(bl((err, bldata) => {
+        file.content.pipe(bl((err, bldata) => {
           expect(err).to.not.exist
           done()
         }))
@@ -94,7 +94,7 @@ module.exports = function (repo) {
       const ds = new DAGService(bs)
       const testExport = exporter(hash, ds)
       testExport.on('data', (dir) => {
-        expect(dir.stream).to.equal(null)
+        expect(dir.content).to.equal(null)
         done()
       })
     })

test/test-importer.js

@@ -38,7 +38,7 @@ module.exports = function (repo) {
         expect(bs58.encode(obj.multihash)).to.equal('QmQmZQxSKQppbsWfVzBvg59Cn3DKtsNVQ94bjAxg2h3Lb8')
         expect(obj.size).to.equal(211)
       })
-      i.write({path: '200Bytes.txt', stream: r})
+      i.write({path: '200Bytes.txt', content: r})
       i.end()
       i.on('end', () => {
         done()
@@ -69,7 +69,7 @@ module.exports = function (repo) {
       i.on('end', () => {
         done()
       })
-      i.write({path: 'foo/bar/200Bytes.txt', stream: r})
+      i.write({path: 'foo/bar/200Bytes.txt', content: r})
       i.end()
     })
 
@@ -85,7 +85,7 @@ module.exports = function (repo) {
       i.on('end', () => {
         done()
       })
-      i.write({path: '1.2MiB.txt', stream: r})
+      i.write({path: '1.2MiB.txt', content: r})
       i.end()
     })
 
@@ -106,7 +106,7 @@ module.exports = function (repo) {
       i.on('end', () => {
         done()
       })
-      i.write({path: 'foo-big/1.2MiB.txt', stream: r})
+      i.write({path: 'foo-big/1.2MiB.txt', content: r})
       i.end()
     })
 
@@ -156,8 +156,8 @@ module.exports = function (repo) {
       i.on('end', () => {
         done()
       })
-      i.write({path: 'pim/200Bytes.txt', stream: r1})
-      i.write({path: 'pim/1.2MiB.txt', stream: r2})
+      i.write({path: 'pim/200Bytes.txt', content: r1})
+      i.write({path: 'pim/1.2MiB.txt', content: r2})
       i.end()
     })
 
@@ -195,9 +195,9 @@ module.exports = function (repo) {
       i.on('end', () => {
         done()
       })
-      i.write({path: 'pam/pum/200Bytes.txt', stream: r1})
-      i.write({path: 'pam/pum/1.2MiB.txt', stream: r2})
-      i.write({path: 'pam/1.2MiB.txt', stream: r3})
+      i.write({path: 'pam/pum/200Bytes.txt', content: r1})
+      i.write({path: 'pam/pum/1.2MiB.txt', content: r2})
+      i.write({path: 'pam/1.2MiB.txt', content: r3})
       i.end()
     })
   })