docs(typedoc): include the events-amqp testing subpath in the API reference entry points (#203)#225
Merged
Merged
Conversation
…erence entry points (#203)
📝 WalkthroughWalkthroughThe TypeDoc configuration file for the events-amqp package is updated to add src/testing.ts as an additional entry point alongside the existing src/index.ts and src/types.ts entries. ChangesTypeDoc Configuration
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
@connectum/auth
@connectum/cli
@connectum/core
@connectum/events
@connectum/events-amqp
@connectum/events-kafka
@connectum/events-nats
@connectum/events-redis
@connectum/healthcheck
@connectum/interceptors
@connectum/otel
@connectum/protoc-gen-catalog
@connectum/reflection
@connectum/test-fixtures
@connectum/testing
commit: |
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.
Summary
Follow-up to #224: the new
@connectum/events-amqp/testingsubpath was not listed in the package's TypeDocentryPoints, sopnpm docs:apisilently omitted theFakeAmqpAdapterAPI pages (the docs-repo pages were generated with this fix applied locally — without it, the next full regen would drop them again).packages/events-amqp/typedoc.json:entryPoints+=src/testing.ts.Change type
Test plan
pnpm docs:apiregenerates the API reference with 8 newtesting/pages (FakeAmqpAdapter,FakeAmqpControl, options/result types) — verified locally; the generated pages shipped in docs(events-amqp): Testing section + API reference for the FakeAmqpAdapter subpath (connectum#203) docs#63.Parity coverage
N/A — TypeDoc configuration only; no runtime or contract surface.
Related
FakeAmqpAdaptertest double via@connectum/events-amqp/testing#203 (the feature issue)🤖 Generated with Claude Code
https://claude.ai/code/session_015Sp8jYmRXyvUmsErDuNJvt