Repository navigation
docs: correct parser parameter default and example index - #82
Merged
blakeembrey merged 1 commit intoOct 30, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #82 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 192 192
Branches 52 52
=========================================
Hits 192 192 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
ParseOptions.parameterscurrently says@default falsein its TypeScript documentation, even though omitting the option parses parameters. The README also gives33as the returned index forimage/svg+xml; charset=utf-8, whose actual length and returned index are28.This corrects the option description/default and the example index, and explains that
indexpoints at the stopping delimiter or the end of the input. Runtime behavior and public types are unchanged.Verified on upstream
d005d8bfd9846bb9eb73a9aad0944536e1a5cf39using Node.js 24.12.0 on Windows:Validation:
npm testpasses (build, Prettier, typecheck, 127 tests, and size limit: 1.09 kB / 1.15 kB). Also executed a separate six-check documentation/API probe: both documentation mismatches fail before the change and all six checks pass after it. No permanent test was added for this documentation-only correction.