Skip to content

docs(child-pool): add JSDoc to ChildPool public methods - #4131

Open
yogeshwaran-c wants to merge 2 commits into
taskforcesh:masterfrom
yogeshwaran-c:docs/child-pool-jsdoc
Open

docs(child-pool): add JSDoc to ChildPool public methods#4131
yogeshwaran-c wants to merge 2 commits into
taskforcesh:masterfrom
yogeshwaran-c:docs/child-pool-jsdoc

Conversation

@yogeshwaran-c

Copy link
Copy Markdown
Contributor

Summary

  • Adds concise JSDoc to public methods of ChildPool so downstream users get IDE hints and parameter help.
  • Documentation only — no runtime or API changes.

Test plan

  • No code logic changed; only comments added
  • npm run build passes locally

Documents ChildPool public methods so downstream users get IDE hints and type help.
@manast

manast commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

This is a private class, and thus we need to mark it as so, otherwise users will get confused believing they can also use this functionality which is strictly internal for BullMQ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants