docs(child-pool): add JSDoc to ChildPool public methods - #4131
Open
yogeshwaran-c wants to merge 2 commits into
Open
docs(child-pool): add JSDoc to ChildPool public methods#4131yogeshwaran-c wants to merge 2 commits into
yogeshwaran-c wants to merge 2 commits into
Conversation
Documents ChildPool public methods so downstream users get IDE hints and type help.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ChildPoolso downstream users get IDE hints and parameter help.Test plan
npm run buildpasses locally