This is an automated email from the ASF dual-hosted git repository.
glynnbird pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb-nano.git
The following commit(s) were added to refs/heads/main by this push:
new 9431c8a provide readme for nano.info function. Closes issue #330
9431c8a is described below
commit 9431c8ad3b0d69ed9e28d9b4404e36b1b7bcb67d
Author: Glynn Bird <[email protected]>
AuthorDate: Fri Apr 21 11:07:21 2023 +0100
provide readme for nano.info function. Closes issue #330
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index a8cf786..7aae405 100644
--- a/README.md
+++ b/README.md
@@ -504,6 +504,16 @@ Listen to db updates, the available `params` are:
* `params.timeout` – Number of seconds until CouchDB closes the connection.
Default is 60.
* `params.heartbeat` – Whether CouchDB will send a newline character (\n) on
timeout. Default is true.
+### nano.info([callback])
+
+Fetch information about the CouchDB cluster:
+
+```js
+const info = await nano.info()
+```
+
+The response is an object with [CouchDB cluster
information](https://docs.couchdb.org/en/stable/intro/api.html#server).
+
## Document functions
### db.insert(doc, [params], [callback])
