Skip to content

fix(docs): resolve all api-extractor and TypeDoc and lint warnings - #638

Merged
nev21 merged 1 commit into
mainfrom
nev21/Warnings
Nov 8, 2026
Merged

nev21 merged 1 commit into
mainfrom
nev21/Warnings

Conversation

@nev21

@nev21 nev21 commented Nov 8, 2026

Copy link
Copy Markdown
Contributor

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.

  • 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)

…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)
@nev21 nev21 added this to the 0.17.0 milestone Nov 8, 2026
@nev21
nev21 requested review from a team as code owners November 8, 2026 17:50
Copilot AI balanced review requested due to automatic review settings November 8, 2026 17:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@codecov

codecov Bot commented Nov 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.21%. Comparing base (5131c96) to head (fd5a1c0).

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           
Files with missing lines Coverage Δ
lib/src/array/arrIndexOfSubset.ts 100.00% <ø> (ø)
lib/src/array/arrKeys.ts 100.00% <ø> (ø)
lib/src/helpers/number.ts 96.96% <ø> (ø)
lib/src/iterator/forOf.ts 100.00% <ø> (ø)
lib/src/iterator/types.ts 100.00% <ø> (ø)
lib/src/string/at.ts 100.00% <ø> (ø)
lib/src/string/count.ts 100.00% <ø> (ø)
lib/src/string/match_all.ts 100.00% <ø> (ø)
lib/src/string/normalize_newlines.ts 100.00% <ø> (ø)
lib/src/timer/microtask.ts 100.00% <100.00%> (ø)
... and 1 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nev21
nev21 enabled auto-merge (squash) November 8, 2026 17:55

@nevware21-bot nevware21-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved by nevware21-bot

@nev21
nev21 merged commit c76f017 into main Nov 8, 2026
10 checks passed
@nev21
nev21 deleted the nev21/Warnings branch November 8, 2026 18:23
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.

3 participants