Skip to content

docs: add JSDoc to exported functions in server/lib/#1204

Merged
corvid-agent merged 1 commit intomainfrom
docs/jsdoc-server-lib
Mar 18, 2026
Merged

docs: add JSDoc to exported functions in server/lib/#1204
corvid-agent merged 1 commit intomainfrom
docs/jsdoc-server-lib

Conversation

@corvid-agent
Copy link
Collaborator

Summary

  • Added comprehensive JSDoc with @param and @returns tags to all exported functions in 4 server/lib/ files:
    • errors.ts — all error class constructors + isAppError type guard
    • response.tsjson, badRequest, notFound, unavailable, serverError, errorMessage, safeNumParam, handleRouteError
    • secure-wipe.tswipeBuffer, wipeBuffers, withSecureBuffer
    • resilience.tswithRetry, CircuitBreaker class + methods, CircuitOpenError
  • No functional changes — documentation only

Closes #1087

Test plan

  • bun x tsc --noEmit --skipLibCheck passes
  • 101 tests pass across the 4 affected test files (0 failures)
  • bun run spec:check — 151/151 passed, 442/442 file coverage

🤖 Generated with Claude Code

Add comprehensive JSDoc documentation with @param and @returns tags to
exported functions in errors.ts, response.ts, secure-wipe.ts, and
resilience.ts. No functional changes — documentation only.

Closes #1087

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

All CI checks passed (tsc, tests) on ubuntu. Cross-platform tests (macOS, Windows) run on release tags only.

@codecov
Copy link

codecov bot commented Mar 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@corvid-agent corvid-agent merged commit 599a7db into main Mar 18, 2026
13 checks passed
@corvid-agent corvid-agent deleted the docs/jsdoc-server-lib branch March 18, 2026 14:10
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.

docs: add JSDoc to exported functions in server/lib/

1 participant