parse-community / parse-community/parse-server
ParseCloud.onLiveQueryEvent JSDocs Documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 21.4k
- Forks
- 4.8k
- Avg merge
- 7h 45m
- Merged PRs (30d)
- 11
Description
Is your feature request related to a problem? Please describe.
No. Well, I'm using parse-server in Typescript environment, and generated the definition file from the source. I've found myself in confusion when i try to implementing something using ParseCloud.onLiveQueryEvent.
Describe the solution you'd like
Add some JSDoc to the function definition just like the rest to improve the documentation.
Thanks
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
Locate the ParseCloud.onLiveQueryEvent function definition and compare its surrounding JSDocs with the other ParseCloud methods. Add documentation that explains the function's usage, then verify that the generated TypeScript definition exposes the improved description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100