Repository navigation
fix(docs): resolve all api-extractor and TypeDoc and lint warnings - #638
Merged
Merged
Conversation
…port lint warning
Fixes the 34 api-extractor warnings (ae-unresolved-link and tsdoc-*) and the
remaining eslint warning. Only doc comments and one unused import change, so
there is no runtime or API change.
- arrIndexOfSubset / arrLastIndexOfSubset: parameter names (theArray, subset,
fromIndex) were written as {@link}, which only resolves to exports; they are
now code spans
- arrKeys / strAt: removed the links to polyArrKeys / polyStrAt, which are not
exported (like the other @group Polyfill functions), and named them as code
- iterForOf, ArrToMapKeySelectorFn, ArrToMapValueSelectorFn,
setMicroTaskFallbackOptions, setNextTickFallbackOptions: the links to the
overloaded arrForEach / arrToMap / scheduleMicrotask / scheduleNextTick are
now code spans. api-extractor requires an overload selector such as
{@link (arrForEach:1)}, which TypeDoc cannot resolve, and no syntax is
accepted by both
- strMatchAll: replaced the link to the non-existent strMatch with
String.prototype.match()
- isIntInRange (number.ts): wrapped "min <= value <= max" in a code span so it
is not parsed as HTML
- strCount: changed the JSDoc-style "@throws {TypeError}" to the TSDoc form
- strNormalizeNewlines: wrapped the "\n", "\r\n", "\r" and "\n\r" values in
code spans so the backslashes are not parsed as escapes
- nextTick: removed the unused getQueueMicrotask import
fix(docs): resolve the remaining TypeDoc warnings
- scheduleMicrotask / scheduleNextTick: give each overload its own doc comment,
so the (callback, options?) signature no longer documents an args parameter
it doesn't have, and the (callback, args, options?) signature gets its own
parameter docs and examples
- typedoc.json: remove the blockTags list, which TypeDoc ignored because
tsdoc.json defines the tags (it warned that the list would be overwritten)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #638 +/- ##
=======================================
Coverage 99.21% 99.21%
=======================================
Files 180 180
Lines 5630 5630
Branches 1264 1264
=======================================
Hits 5586 5586
Misses 44 44
🚀 New features to boost your workflow:
|
nev21
enabled auto-merge (squash)
November 8, 2026 17:55
nevware21-bot
approved these changes
Nov 8, 2026
nevware21-bot
left a comment
Contributor
There was a problem hiding this comment.
Approved by nevware21-bot
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.
fix(docs): resolve all api-extractor TSDoc warnings and the unused import lint warning
Fixes the 34 api-extractor warnings (ae-unresolved-link and tsdoc-*) and the remaining eslint warning. Only doc comments and
one unused import change, so there is no runtime or API change.
fix(docs): resolve the remaining TypeDoc warnings