unref event is not documented
- Dominant language
- JavaScript
- Stars
- 17.6k
- Forks
- 1.5k
- PR merge metrics
- No merged PRs in 30d
Description
Perhaps this is deliberate, but the `'unref'` event fired at https://github.com/pouchdb/pouchdb/blob/c8e532e4d817aa6d6122f7944967c0293c3a26a9/packages/node_modules/pouchdb-core/src/constructor.js#L28 and tested at https://github.com/pouchdb/pouchdb/blob/c8e532e4d817aa6d6122f7944967c0293c3a26a9/tests/integration/test.close.js#L87-L119 is not documented.
Contributor guide
Research direction
Start with the `unref` event emission in `packages/node_modules/pouchdb-core/src/constructor.js` and its coverage in `tests/integration/test.close.js` lines 87-119. Find the relevant PouchDB API or event documentation, document when the event fires and what it represents, and confirm the documentation matches the tested behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100