tursodatabase / tursodatabase/libsql-client-ts
Improve JSDoc
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 576
- Forks
- 69
- PR merge metrics
- No merged PRs in 30d
Description
Currently a very few APIs are documented with JSDoc, or some are incorrectly set up (like libsql-client/ws/ConnState).
This is not a good DX for consumers of libSQL JS SDK.
This work can be split up in sub-tasks if needed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the TypeScript client package and the JSDoc example at packages/libsql-client/src/ws.ts around ConnState. Inventory which public APIs lack documentation or have incorrect JSDoc, then define a focused sub-task. Done means the selected APIs have accurate JSDoc and the relevant documentation checks pass, if available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100