@nxtedition/lib 20.0.4 → 20.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/couch.js +4 -3
  2. package/package.json +1 -1
package/couch.js CHANGED
@@ -121,15 +121,16 @@ export function makeCouch(opts) {
121
121
  }
122
122
 
123
123
  /**
124
- * Fetches changes from the CouchDB changes feed.
125
- *
126
124
  * @param {Object} [options={}] - The options for fetching changes.
127
125
  * @param {AbortSignal} [options.signal=null] - The signal to abort the request.
128
126
  * @param {boolean} [options.descending=false] - Whether to return changes in descending order.
129
127
  * @param {boolean} [options.include_docs=false] - Whether to include the document with each change.
130
128
  * @param {number} [options.seq_interval=null] - The interval at which to return sequence numbers.
129
+ * @param {string} [options.live=false] - The sequence number to start from.
130
+ * @param {number} [options.heartbeat=60000] - The interval at which to send a heartbeat.
131
+ * @param {function} [options.retry=null] - The function to retry the request on error.
131
132
  * @param {string} [options.since=null] - The sequence number to start from.
132
- * @yields {Object} The changes from the CouchDB changes feed.
133
+ * @yields {{ id: string, seq?: string, doc?: string, deleted?: boolean, changes: Array<{ rev: string }> }}
133
134
  */
134
135
  async function* changes({ client = defaultClient, signal = null, ...options } = {}) {
135
136
  const params = {}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nxtedition/lib",
3
- "version": "20.0.4",
3
+ "version": "20.0.6",
4
4
  "license": "MIT",
5
5
  "author": "Robert Nagy <robert.nagy@boffins.se>",
6
6
  "type": "module",