simplify Nano a bit. Removed some old code and made "relax" a simpler function. At the same time, i have made the ...AsStream functions "async" as they were a bit odd in that regard, returning synchronously.

Author: Glynn Bird

README.md

@@ -347,7 +347,7 @@ const dblist = await nano.db.list()
 Lists all the CouchDB databases as a stream:
 
 ```js
-nano.db.listAsStream()
+(await nano.db.listAsStream())
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -418,7 +418,7 @@ const c = await nano.db.changes('alice')
 Same as `nano.db.changes` but returns a stream.
 
 ```js
-nano.db.changes('alice').pipe(process.stdout)
+( await nano.db.changes('alice')).pipe(process.stdout)
 ```
 
 ### nano.db.info()
@@ -602,7 +602,7 @@ const doclist = await alice.list({include_docs: true})
 List all the docs in the database as a stream.
 
 ```js
-alice.listAsStream()
+(await alice.listAsStream())
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -858,12 +858,12 @@ Fetch documents from a partition as a stream:
 
 ```js
 // fetch document id/revs from a partition
-nano.db.partitionedListAsStream('canidae')
+(await nano.db.partitionedListAsStream('canidae'))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 
 // add document bodies but limit size of response
-nano.db.partitionedListAsStream('canidae', { include_docs: true, limit: 5 })
+(await nano.db.partitionedListAsStream('canidae', { include_docs: true, limit: 5 }))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -883,7 +883,7 @@ Query documents from a partition by supplying a Mango selector as a stream:
 
 ```js
 // find document whose name is 'wolf' in the 'canidae' partition
-db.partitionedFindAsStream('canidae', { 'selector' : { 'name': 'Wolf' }})
+(await db.partitionedFindAsStream('canidae', { 'selector' : { 'name': 'Wolf' }}))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -908,7 +908,7 @@ Search documents from a partition by supplying a Lucene query as a stream:
 const params = {
   q: 'name:\'Wolf\''
 }
-db.partitionedSearchAsStream('canidae', 'search-ddoc', 'search-index', params)
+(await db.partitionedSearchAsStream('canidae', 'search-ddoc', 'search-index', params))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 // { total_rows: ... , bookmark: ..., rows: [ ...] }
@@ -938,7 +938,7 @@ const params = {
   endkey: 'b',
   limit: 1
 }
-db.partitionedViewAsStream('canidae', 'view-ddoc', 'view-name', params)
+(await db.partitionedViewAsStream('canidae', 'view-ddoc', 'view-name', params))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 // { rows: [ { key: ... , value: [Object] } ] }
@@ -994,7 +994,7 @@ fs.readFile('rabbit.png', (err, data) => {
 ### db.attachment.insertAsStream(docname, attname, att, contenttype, [params])
 
 As of Nano 9.x, the function `db.attachment.insertAsStream` is now deprecated. Now simply pass
-a readable stream to `db.attachment.insert` as the third paramseter.
+a readable stream to `db.attachment.insert` as the third parameter.
 
 ### db.attachment.get(docname, attname, [params])
 
@@ -1012,7 +1012,7 @@ fs.writeFile('rabbit.png', body)
 
 ```js
 import fs from 'node:fs'
-alice.attachment.getAsStream('rabbit', 'rabbit.png')
+(await alice.attachment.getAsStream('rabbit', 'rabbit.png'))
   .on('error', e => console.error)
   .pipe(fs.createWriteStream('rabbit.png'))
 ```
@@ -1062,7 +1062,7 @@ const body = alice.view('characters', 'happy_ones', { include_docs: true })
 Same as `db.view` but returns a stream:
 
 ```js
-alice.viewAsStream('characters', 'happy_ones', {reduce: false})
+(await alice.viewAsStream('characters', 'happy_ones', {reduce: false}))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -1080,7 +1080,7 @@ const body = await alice.viewWithList('characters', 'happy_ones', 'my_list')
 Calls a list function fed by the given view from the specified design document as a stream.
 
 ```js
-alice.viewWithListAsStream('characters', 'happy_ones', 'my_list')
+(await alice.viewWithListAsStream('characters', 'happy_ones', 'my_list'))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -1143,7 +1143,7 @@ Check out the tests for a fully functioning example.
 Calls a view of the specified design with optional query string additions `params`. Returns stream.
 
 ```js
-alice.search('characters', 'happy_ones', { q: 'cat' }).pipe(process.stdout)
+(await alice.search('characters', 'happy_ones', { q: 'cat' })).pipe(process.stdout)
 ```
 
 ### db.find(selector)
@@ -1177,7 +1177,7 @@ const q = {
   fields: [ "name", "age", "tags", "url" ],
   limit:50
 }
-alice.findAsStream(q)
+(await alice.findAsStream(q))
   .on('error', (e) => console.error('error', e))
   .pipe(process.stdout)
 ```
@@ -1260,7 +1260,7 @@ import fs from 'node:fs'
 import Nano from 'nano'
 const nano = Nano('http://127.0.0.1:5984/')
 const alice = nano.use('alice')
-alice.attachment.getAsStream('rabbit', 'picture.png')
+(await alice.attachment.getAsStream('rabbit', 'picture.png'))
   .on('error', (e) => console.error('error', e))
   .pipe(fs.createWriteStream('/tmp/rabbit.png'))
 ```

lib/changesreader.js

@@ -278,18 +278,21 @@ export default class ChangesReader {
     }
     const lin = liner()
     const cp = changeProcessor(self.ee, self.batchSize)
-    self.request(req)
-      .on(EVENT_ERROR, (e) => {
-        self.ee.emit(EVENT_ERROR, e)
-      })
-      .pipe(lin)
-      .pipe(cp)
-      .on('finish', (lastSeq) => {
-        // the 'end' event was triggering before the last data event
-        setTimeout(() => {
-          self.ee.emit('end', cp.lastSeq)
-        }, 10)
-      })
+    setImmediate(async () => {
+      const s = await self.request(req)
+      s.on(EVENT_ERROR, (e) => {
+          self.ee.emit(EVENT_ERROR, e)
+        })
+        .pipe(lin)
+        .pipe(cp)
+        .on('finish', (lastSeq) => {
+          // the 'end' event was triggering before the last data event
+          setTimeout(() => {
+            self.ee.emit('end', cp.lastSeq)
+          }, 10)
+        })
+    })
+
 
     return self.ee
   }

lib/nano.d.ts

@@ -395,10 +395,10 @@ declare namespace nano {
     list(params: DocumentListParams): Promise<DocumentListResponse<D>>;
     /** List document from this database as a stream.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/bulk-api.html#get--db-_all_docs} */
-    listAsStream(): NodeJS.ReadStream;
+    listAsStream(): Promise<NodeJS.ReadStream>;
     /** List document from this database as a stream with options.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/bulk-api.html#get--db-_all_docs} */
-    listAsStream(params: DocumentListParams): NodeJS.ReadStream;
+    listAsStream(params: DocumentListParams): Promise<NodeJS.ReadStream>;
     /** Fetch a list of documents by _id.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs} */
     fetch(docnames: BulkFetchDocsWrapper): Promise<DocumentFetchResponse<D>>;
@@ -482,7 +482,7 @@ declare namespace nano {
       designname: string,
       searchname: string,
       params: DocumentSearchParams
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Low-level wrapper that executes a view from a Design Document.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/ddoc/views.html#get--db-_design-ddoc-_view-view} */
     baseView<V>(
@@ -509,14 +509,14 @@ declare namespace nano {
     viewAsStream<V>(
       designname: string,
       viewname: string
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Executes a view from a Design Document, with options as a stream
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/ddoc/views.html#get--db-_design-ddoc-_view-view} */
     viewAsStream<V>(
       designname: string,
       viewname: string,
       params: DocumentViewParams
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Applies a list function to a view.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/ddoc/render.html#db-design-design-doc-list-list-name-view-name} */
     viewWithList(
@@ -538,15 +538,15 @@ declare namespace nano {
         designname: string,
         viewname: string,
         listname: string
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Applies a list function to a view with options as a stream.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/ddoc/render.html#db-design-design-doc-list-list-name-view-name} */
     viewWithListAsStream(
         designname: string,
         viewname: string,
         listname: string,
         params: DocumentViewParams
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Run Mango query.
      * @see Docs: {@link http://docs.couchdb.org/en/latest/api/database/find.html#db-find} */
     find(query: MangoQuery): Promise <MangoResponse<D>>;
@@ -563,13 +563,13 @@ declare namespace nano {
     partitionedList(partitionKey: string, params?: DocumentFetchParams): Promise<DocumentListResponse<D>>;
     /** List documents in a single partition in this database as a stream.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#db-partition-partition-all-docs} */
-    partitionedListAsStream(partitionKey: string, params?: DocumentFetchParams): NodeJS.ReadStream;
+    partitionedListAsStream(partitionKey: string, params?: DocumentFetchParams): Promise<NodeJS.ReadStream>;
     /** Run Mango query a single partition in this database.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#db-partition-partition-id-find} */
     partitionedFind(partitionKey: string, query: MangoQuery): Promise <MangoResponse<D>>;
     /** Run Mango query a single partition in this database, as a stream.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#db-partition-partition-id-find} */
-    partitionedFindAsStream(partitionKey: string, query: MangoQuery): NodeJS.ReadStream;
+    partitionedFindAsStream(partitionKey: string, query: MangoQuery): Promise<NodeJS.ReadStream>;
     /** Run a full-text search in a single partition in this database. */
     partitionedSearch<V>(
       partitionKey: string,
@@ -583,7 +583,7 @@ declare namespace nano {
       designname: string,
       searchname: string,
       params: DocumentSearchParams
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
     /** Executes the specified view function in a single partition from the specified design document.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/partitioned-dbs.html#db-partition-partition-design-design-doc-view-view-name} */
     partitionedView<V>(
@@ -599,7 +599,7 @@ declare namespace nano {
       designname: string,
       viewname: string,
       params: DocumentViewParams
-    ): NodeJS.ReadStream;
+    ): Promise<NodeJS.ReadStream>;
   }
 
   /** attachment data */
@@ -649,7 +649,7 @@ declare namespace nano {
     get(docname: string, attname: string): Promise<Buffer>;
     /** Get an attachment as a stream.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/document/attachments.html#get--db-docid-attname} */
-    getAsStream(docname: string, attname: string): NodeJS.ReadStream;
+    getAsStream(docname: string, attname: string): Promise<NodeJS.ReadStream>;
     /** Get an attachment with options.
      * @see Docs: {@link https://docs.couchdb.org/en/latest/api/document/attachments.html#get--db-docid-attname} */
     get(