docs(add): updated API instructions for add

fergiemcdowall · Jun 23, 2017 · 3dd796b · 3dd796b
1 parent af771a8
commit 3dd796b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 9 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -343,10 +343,7 @@ being sent on top of one another then it is safer to use
 // s is a Readable stream in object mode
 s.pipe(si.defaultPipeline(batchOptions))
   .pipe(si.add())
-  .on('data', function(d) {
-    // this function needs to be called if you want to listen for the end event
-  })
-  .on('end', function() {
+  .on('finish', function() {
     // complete
   })
 ```

diff --git a/docs/add.md b/docs/add.md
@@ -10,10 +10,7 @@ request(url)                      // <- could also be something like fs.getReadS
   .pipe(JSONStream.parse())
   .pipe(index.defaultPipeline())
   .pipe(index.add())
-  .on('data', function(d) {
-    // this function needs to be called if you want to listen for the end event
-  })
-  .on('end', function() {
+  .on('finish', function() {
     // complete
   })
 ```
@@ -120,6 +117,5 @@ The `.add` is a writable stream that accepts the processed documents
 dataStream                       // <- stream of docs to be indexed
   .pipe(index.defaultPipeline())
   .pipe(index.add())
-                                 // <- you must drain and end the stream here (see top of page)
 ```