chore: remove exporter code

Author: achingbrain

README.md

@@ -1,13 +1,12 @@
-IPFS unixFS Engine
-==================
+# ipfs-unixfs-importer
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-[![Jenkins](https://ci.ipfs.team/buildStatus/icon?job=ipfs/js-ipfs-unixfs-engine/master)](https://ci.ipfs.team/job/ipfs/job/js-ipfs-unixfs-engine/job/master/)
-[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs-engine/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs-engine)
-[![Dependency Status](https://david-dm.org/ipfs/js-ipfs-unixfs-engine.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs-engine)
+[![Jenkins](https://ci.ipfs.team/buildStatus/icon?job=ipfs/js-ipfs-unixfs-importer/master)](https://ci.ipfs.team/job/ipfs/job/js-ipfs-unixfs-importer/job/master/)
+[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs-importer/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs-importer)
+[![Dependency Status](https://david-dm.org/ipfs/js-ipfs-unixfs-importer.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs-importer)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 ![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
 ![](https://img.shields.io/badge/Node.js-%3E%3D8.0.0-orange.svg?style=flat-square)
@@ -22,26 +21,21 @@ IPFS unixFS Engine
 
 - [Install](#install)
 - [Usage](#usage)
-  - [Example Importer](#example-importer)
-  - [Importer API](#importer-api)
-    - [const add = new Importer(dag)](#const-add--new-importerdag)
-  - [Example Exporter](#example-exporter)
-  - [Exporter: API](#exporter-api)
-  - [new Exporter(hash, dagService)](#new-exporterhash-dagservice)
+  - [Example](#example)
+  - [API](#api)
+    - [const add = importer(dag, options)](#const-import--importerdag--options)
 - [Contribute](#contribute)
 - [License](#license)
 
 ## Install
 
 ```
-> npm install ipfs-unixfs-engine
+> npm install ipfs-unixfs-importer
 ```
 
 ## Usage
 
-### Importer
-
-#### Importer example
+### Example
 
 Let's create a little directory to import:
 
@@ -55,36 +49,32 @@ Let's create a little directory to import:
 And write the importing logic:
 
 ```js
-const Importer = require('ipfs-unixfs-engine').Importer
-
-// You need to create and pass an ipld-resolve instance
-// https://github.com/ipld/js-ipld-resolver
-const filesAddStream = new Importer(<ipld-resolver instance>)
-
-// An array to hold the return of nested file/dir info from the importer
-// A root DAG Node is received upon completion
-
-const res = []
+const importer = require('ipfs-unixfs-importer')
+const pull = require('pull-stream')
 
 // Import path /tmp/foo/bar
-const rs = fs.createReadStream(file)
-const rs2 = fs.createReadStream(file2)
-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
-filesAddStream.on('data', (info) => res.push(info))
-
-// The end event of the stream signals that the importer is done
-filesAddStream.on('end', () => console.log('Finished filesAddStreaming files!'))
-
-// Calling write on the importer to filesAddStream the file/object tuples
-filesAddStream.write(input)
-filesAddStream.write(input2)
-filesAddStream.end()
+pull(
+  pull.values([{
+    path: '/tmp/foo/bar',
+    content: fs.createReadStream(file)
+  }, {
+    path: '/tmp/foo/quxx',
+    content: fs.createReadStream(file2)
+  }
+  }]),
+
+  // You need to create and pass an ipld-resolve instance
+  // https://github.com/ipld/js-ipld-resolver
+  importer(<ipld-resolver instance>, <options>),
+
+  // Handle the error and do something with the results
+  pull.collect((err, files) => {
+    console.info(files)
+  })
+)
 ```
 
-When run, the stat of DAG Node is outputted for each file on data event until the root:
+When run, the stat of DAGNode is outputted for each file on data event until the root:
 
 ```js
 { multihash: <Buffer 12 20 bd e2 2b 57 3f 6f bd 7c cc 5a 11 7f 28 6c a2 9a 9f c0 90 e1 d4 16 d0 5f 42 81 ec 0c 2a 7f 7f 93>,
@@ -105,20 +95,20 @@ When run, the stat of DAG Node is outputted for each file on data event until th
 
 ```
 
-#### Importer API
+#### API
 
 ```js
-const Importer = require('ipfs-unixfs-engine').Importer
+const importer = require('ipfs-unixfs-importer')
 ```
 
-#### const import = new Importer(dag [, options])
+#### const import = importer(dag [, options])
 
 The `import` object is a duplex pull stream that takes objects of the form:
 
 ```js
 {
   path: 'a name',
-  content: (Buffer or Readable stream)
+  content: (Buffer, pull-stream emitting Buffers or a Readable stream)
 }
 ```
 
@@ -152,85 +142,14 @@ The input's file paths and directory structure will be preserved in the [`dag-pb
 - `rawLeaves` (boolean, defaults to false): When a file would span multiple DAGNodes, if this is true the leaf nodes will not be wrapped in `UnixFS` protobufs and will instead contain the raw file bytes
 - `leafType` (string, defaults to `'file'`) what type of UnixFS node leaves should be - can be `'file'` or `'raw'` (ignored when `rawLeaves` is `true`)
 
-### Exporter
-
-#### Exporter example
-
-```js
-// Create an export source pull-stream cid or ipfs path you want to export and a
-// <dag or ipld-resolver instance> to fetch the file from
-const filesStream = Exporter(<cid or ipfsPath>, <dag or ipld-resolver instance>)
-
-// Pipe the return stream to console
-filesStream.on('data', (file) => file.content.pipe(process.stdout))
-```
-
-#### Exporter API
-
-```js
-const Exporter = require('ipfs-unixfs-engine').Exporter
-```
-
-### new Exporter(<cid or ipfsPath>, <dag or ipld-resolver>, <options>)
-
-Uses the given [dag API][] or an [ipld-resolver instance][] to fetch an IPFS [UnixFS][] object(s) by their multiaddress.
-
-Creates a new readable stream in object mode that outputs objects of the form
-
-```js
-{
-  path: 'a name',
-  content: (Buffer or Readable stream)
-}
-```
-
-#### `offset` and `length`
-
-`offset` and `length` arguments can optionally be passed to the reader function.  These will cause the returned stream to only emit bytes starting at `offset` and with length of `length`.
-
-See [the tests](test/reader.js) for examples of using these arguments.
-
-```js
-const exporter = require('ipfs-unixfs-engine').exporter
-const pull = require('pull-stream')
-const drain = require('pull-stream/sinks/drain')
-
-pull(
-  exporter(cid, ipldResolver, {
-    offset: 0,
-    length: 10
-  })
-  drain((file) => {
-    // file.content is a pull stream containing only the first 10 bytes of the file
-  })
-)
-```
-
-#### Errors
-
-Errors are received by [pull-stream][] sinks.
-
-```js
-const exporter = require('ipfs-unixfs-engine').exporter
-const pull = require('pull-stream')
-const collect = require('pull-stream/sinks/collect')
-
-pull(
-  exporter(cid, ipldResolver)
-  collect((error, chunks) => {
-    // handle the error
-  })
-)
-```
-
 [dag API]: https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DAG.md
 [ipld-resolver instance]: https://github.com/ipld/js-ipld-resolver
 [UnixFS]: https://github.com/ipfs/specs/tree/master/unixfs
 [pull-stream]: https://www.npmjs.com/package/pull-stream
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-engine/issues)!
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
 
 This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "ipfs-unixfs-engine",
+  "name": "ipfs-unixfs-importer",
   "version": "0.34.0",
-  "description": "JavaScript implementation of the unixfs Engine used by IPFS",
+  "description": "JavaScript implementation of the UnixFs importer used by IPFS",
   "leadMaintainer": "Alex Potsides <[email protected]>",
   "main": "src/index.js",
   "browser": {
@@ -22,26 +22,27 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ipfs/js-ipfs-unixfs-engine.git"
+    "url": "git+https://github.com/ipfs/js-ipfs-unixfs-importer.git"
   },
   "keywords": [
     "IPFS"
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/ipfs/js-ipfs-unixfs-engine/issues"
+    "url": "https://github.com/ipfs/js-ipfs-unixfs-importer/issues"
   },
   "engines": {
     "node": ">=8.0.0",
     "npm": ">=3.0.0"
   },
-  "homepage": "https://github.com/ipfs/js-ipfs-unixfs-engine#readme",
+  "homepage": "https://github.com/ipfs/js-ipfs-unixfs-importer#readme",
   "devDependencies": {
     "aegir": "^17.0.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
     "ipfs-block-service": "~0.15.1",
     "ipfs-repo": "~0.25.0",
+    "ipfs-unixfs-exporter": "~0.34.0",
     "ipld": "~0.20.0",
     "mkdirp": "~0.5.1",
     "multihashes": "~0.4.14",