Correct JSDoc for stateless escapeAll and quoteAll#2387
Merged
ericcornelissen merged 3 commits intomainfrom Mar 4, 2026
Merged
Correct JSDoc for stateless escapeAll and quoteAll#2387ericcornelissen merged 3 commits intomainfrom
escapeAll and quoteAll#2387ericcornelissen merged 3 commits intomainfrom
Conversation
Correct the description in the JSDoc for `escapeAll` and `quoteAll` in the stateless module. It incorrectly stated that non-array inputs are converted to one-element arrays (which was the behavior in v1 of this library). It now states that these are rejected explicitly, which has been added to the stateful variants' documentation too for clarity.
ericcornelissen
added
the
documentation
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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
1 participant
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
Correct the description in the JSDoc for
escapeAllandquoteAllin the stateless module. It incorrectly stated that non-array inputs are converted to one-element arrays (which was the behavior in v1 of this library). It now states that these are rejected explicitly, which has been added to the stateful variants' documentation too for clarity.This problem was found by Codex.