Skip to content

Commit

Permalink
allow clean merge
Browse files Browse the repository at this point in the history
  • Loading branch information
Glynn Bird committed Aug 14, 2024
2 parents e16ad54 + 8e1c24a commit 6ee2510
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 33 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ To use `nano` you need to connect it to your CouchDB install, to do that:
const nano = require('nano')('http://127.0.0.1:5984');
```

> Note: The URL you supply may also contain authentication credentials e.g. `http://admin:mypassword@127.0.0.1:5984`.
> Note: Supplying authentication credentials in the URL e.g. `http://admin:mypassword@localhost:5984` is deprecated. Use `nano.auth` instead.
To create a new database:

Expand Down Expand Up @@ -539,7 +539,7 @@ const response = await alice.insert({ _id: 'myid', _rev: '1-23202479633c2b380f79

### db.destroy(docname, rev, [callback])

Removes a document from CouchDB whose `_id` is `docname` and who's revision is `_rev`:
Removes a document from CouchDB whose `_id` is `docname` and whose revision (`_rev`) is `rev`:

```js
const response = await alice.destroy('rabbit', '3-66c01cdf99e84c83a9b3fe65b88db8c0')
Expand Down Expand Up @@ -708,7 +708,7 @@ You may supply a number of options when you start to listen to the changes feed:
| includeDocs | Whether to include document bodies or not | false | e.g. true |
| wait | For `get`/`start` mode, automatically pause the changes reader after each request. When the the user calls `resume()`, the changes reader will resume. | false | e.g. true |
| fastChanges | Adds a seq_interval parameter to fetch changes more quickly | false | true | |
| selector | Filters the changes feed with the supplied Mango selector | {"name":"fred} | null | |
| selector | Filters the changes feed with the supplied Mango selector | null | {"name":"fred} | |
| timeout | The number of milliseconds a changes feed request waits for data| 60000 | 10000 |

The events it emits are as follows:s
Expand Down
44 changes: 16 additions & 28 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
},
"devDependencies": {
"undici": "^6.2.1",
"@types/node": "^20.10.6",
"typescript": "^5.3.3"
"@types/node": "^22.3.0",
"typescript": "^5.5.4"
},
"scripts": {
"test": "tsc lib/nano.d.ts && node --test ./test/*.test.js"
Expand Down

0 comments on commit 6ee2510

Please sign in to comment.