Skip to content

Commit 9431c8a

Browse files
author
Glynn Bird
committed
provide readme for nano.info function. Closes issue #330
1 parent b13b7c7 commit 9431c8a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,16 @@ Listen to db updates, the available `params` are:
504504
* `params.timeout` – Number of seconds until CouchDB closes the connection. Default is 60.
505505
* `params.heartbeat` – Whether CouchDB will send a newline character (\n) on timeout. Default is true.
506506

507+
### nano.info([callback])
508+
509+
Fetch information about the CouchDB cluster:
510+
511+
```js
512+
const info = await nano.info()
513+
```
514+
515+
The response is an object with [CouchDB cluster information](https://docs.couchdb.org/en/stable/intro/api.html#server).
516+
507517
## Document functions
508518

509519
### db.insert(doc, [params], [callback])

0 commit comments

Comments
 (0)