Skip to content

Add inline JSDoc to all public class fields#195

Merged
baelter merged 1 commit intomainfrom
chore/lint-and-docs
Mar 16, 2026
Merged

Add inline JSDoc to all public class fields#195
baelter merged 1 commit intomainfrom
chore/lint-and-docs

Conversation

@baelter
Copy link
Copy Markdown
Member

@baelter baelter commented Mar 16, 2026

Summary

  • Add inline JSDoc to all undocumented public class fields across AMQPError, AMQPBaseClient, AMQPChannel, AMQPConsumer, AMQPClient, AMQPWebSocketClient, and AMQPMessage
  • Replace legacy @property tags on class-level JSDoc with per-field docs (TypeDoc reads member-level comments directly)
  • Mark internal fields (textEncoder, bufferPool, confirmId, delivery, getMessage, returned) with @internal so stripInternal: true removes them from .d.ts output

Test plan

  • npm run typecheck — zero errors

@baelter baelter force-pushed the chore/lint-and-docs branch from 83ab416 to 72133df Compare March 16, 2026 12:32
@baelter baelter changed the title Upgrade eslint to strict+stylistic, add JSDoc to public fields Cherry-pick lint rules, add JSDoc to public fields Mar 16, 2026
@baelter baelter force-pushed the chore/lint-and-docs branch from 72133df to a388147 Compare March 16, 2026 12:46
@baelter baelter changed the title Cherry-pick lint rules, add JSDoc to public fields Add inline JSDoc to all public class fields Mar 16, 2026
@baelter baelter force-pushed the chore/lint-and-docs branch 3 times, most recently from 5379c6d to b9a3e86 Compare March 16, 2026 13:11
@baelter baelter force-pushed the chore/lint-and-docs branch from b9a3e86 to d69524e Compare March 16, 2026 13:26
@baelter baelter marked this pull request as ready for review March 16, 2026 13:49
@baelter baelter merged commit 8d76a59 into main Mar 16, 2026
6 checks passed
@baelter baelter deleted the chore/lint-and-docs branch March 16, 2026 13:49
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.

1 participant