Add missing API docs

nodestream · Jul 16, 2016 · df04db9 · df04db9
1 parent a6ffd9c
commit df04db9
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/lib/nodestream.js b/lib/nodestream.js
@@ -67,6 +67,11 @@ class Nodestream {
     }
   }
 
+  /**
+   * Create a new pipeline from this Nodestream instance
+   *
+   * @return    {Pipeline}
+   */
   pipeline() {
     return new Pipeline({
       adapter: this[scope].adapter,

diff --git a/lib/pipeline.js b/lib/pipeline.js
@@ -14,6 +14,9 @@ const Domain = require('domain').Domain
 const uuid = require('uuid')
 const scope = Symbol('nodestream internal')
 
+/**
+ * Pipeline - a set of ordered transforms
+ */
 class Pipeline {
 
   constructor(options) {
@@ -30,6 +33,14 @@ class Pipeline {
     }
   }
 
+  /**
+   * Use the given transform plugin in this pipeline
+   *
+   * @param     {String}    transform     The transform's `identity`
+   * @param     {Object?}   options       Options to be passed to the transform when a file is about
+   *                                      to be processed
+   * @return    {this}
+   */
   use(transform, options) {
     const transformer = this[scope].transforms.get(transform)