removed .createExplainStream()

Author: 75lb

README.md

@@ -13,8 +13,8 @@
 ## jsdoc-api
 A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a few features:
 
-- Sync, async (Promise) and streaming interfaces on the two main jsdoc operations ('explain' and 'render documentation').
-- Input (source code) can supplied as a string, set of file names/globs or a stream.
+- Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
+- Input (source code) can supplied as a string or set of file names/globs.
 - Optional caching, dramatically speeding up future invocations with the same input.
 - Supports html input
 
@@ -50,7 +50,6 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
         * [.cache](#module_jsdoc-api.cache) : <code>[cache-point](https://github.com/75lb/cache-point)</code>
         * [.explainSync([options])](#module_jsdoc-api.explainSync) ⇒ <code>Array.&lt;object&gt;</code>
         * [.explain([options])](#module_jsdoc-api.explain) ⇒ <code>Promise</code>
-        * [.createExplainStream([options])](#module_jsdoc-api.createExplainStream) ⇒ <code>Duplex</code>
         * [.renderSync([options])](#module_jsdoc-api.renderSync)
     * _inner_
         * [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
@@ -101,23 +100,6 @@ Returns a promise for the jsdoc explain output.
 | --- | --- |
 | [options] | <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code> | 
 
-<a name="module_jsdoc-api.createExplainStream"></a>
-
-### jsdoc.createExplainStream([options]) ⇒ <code>Duplex</code>
-Returns a duplex stream, into which you can pipe source code and receive explain output at the other end.
-
-**Kind**: static method of <code>[jsdoc-api](#module_jsdoc-api)</code>  
-
-| Param | Type |
-| --- | --- |
-| [options] | <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code> | 
-
-**Example**  
-```js
-fs.createReadStream('source-code.js')
-  .pipe(jsdoc.createExplainStream())
-  .pipe(process.stdout)
-```
 <a name="module_jsdoc-api.renderSync"></a>
 
 ### jsdoc.renderSync([options])

es5/jsdoc-api.js

@@ -4,7 +4,6 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 exports.explainSync = explainSync;
 exports.explain = explain;
-exports.createExplainStream = createExplainStream;
 exports.renderSync = renderSync;
 
 var path = require('path');
@@ -26,12 +25,6 @@ function explain(options) {
   return command.execute();
 }
 
-function createExplainStream(options) {
-  options = new JsdocOptions(options);
-  var ExplainStream = require('./explain-stream');
-  return new ExplainStream(explain, options);
-}
-
 function renderSync(options) {
   options = new JsdocOptions(options);
   var RenderSync = require('./render-sync');

lib/explain-stream.js

@@ -3,8 +3,8 @@
 /**
  * A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a few features:
  *
- * - Sync, async (Promise) and streaming interfaces on the two main jsdoc operations ('explain' and 'render documentation').
- * - Input (source code) can supplied as a string, set of file names/globs or a stream.
+ * - Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
+ * - Input (source code) can supplied as a string or set of file names/globs.
  * - Optional caching, dramatically speeding up future invocations with the same input.
  * - Supports html input
  *
@@ -37,7 +37,6 @@
  */
 exports.explainSync = explainSync
 exports.explain = explain
-exports.createExplainStream = createExplainStream
 exports.renderSync = renderSync
 
 const path = require('path')
@@ -78,23 +77,6 @@ function explain (options) {
   return command.execute()
 }
 
-/**
- * Returns a duplex stream, into which you can pipe source code and receive explain output at the other end.
- *
- * @param [options] {module:jsdoc-api~JsdocOptions}
- * @returns {Duplex}
- * @static
- * @example
- * fs.createReadStream('source-code.js')
- *   .pipe(jsdoc.createExplainStream())
- *   .pipe(process.stdout)
- */
-function createExplainStream (options) {
-  options = new JsdocOptions(options)
-  const ExplainStream = require('./explain-stream')
-  return new ExplainStream(explain, options)
-}
-
 /**
  * Render jsdoc documentation.
  *

lib/jsdoc-api.js

@@ -12,20 +12,3 @@ test('.explain({ files, html: true })', function () {
       a.deepEqual(output, f.getExpectedOutput(output))
     })
 })
-
-test('.createExplainStream({ files, html: true })', function () {
-  var f = new Fixture('html', '0-src.html')
-  return new Promise(function (resolve, reject) {
-    jsdoc.createExplainStream({ files: f.sourcePath, html: true })
-      .pipe(collectJson(function (output) {
-        var expectedOutput = f.getExpectedOutput(output)
-        try {
-          a.deepEqual(output, expectedOutput)
-          resolve()
-        } catch (err) {
-          reject(err)
-        }
-      }))
-      .on('error', reject)
-  })
-})