feat: document the full public API and export supporting types#93
Merged
Conversation
Add JSDoc to every exported symbol and property across the package's entrypoints (build, dev, server, client, utils/*) and the symbols they re-export, so the API renders fully on JSR instead of showing "no documentation available". Also export the route-loader types (RouteModuleLoader, RootRouteModuleLoader) and BivariantComponent, which public route types already referenced, so their docs resolve instead of pointing at private types. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the forceful "SYSTEM RULE / binding system rules" framing with a calm pointer to this repo's AGENTS.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
KyleJune
pushed a commit
that referenced
this pull request
Jun 14, 2026
# [0.8.0](0.7.1...0.8.0) (2026-06-14) ### Features * document the full public API and export supporting types ([#93](#93)) ([85aaa0b](85aaa0b))
|
🎉 This PR is included in version 0.8.0 🎉 The release is available on: Your semantic-release 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
1 participant
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
Brings the package to complete JSDoc coverage of its public API so it renders fully on JSR instead of showing "no documentation available". Every exported symbol — and every property/member of exported interfaces, types, and classes — across all entrypoints in
src/deno.jsonis now documented, including symbols reached through re-exports.Released as a minor because it also exports a few previously-internal types that the public API already referenced.
What changed
build,dev,server,client, andutils/*entrypoints, plus the symbols they re-export (_client.tsx). CoversBuilderfields/methods, theRoute*Argsinterface properties,RootRouteModule,ServerFlags(incl.loader/action),ClientRoute/Client, and thecreateRoutesStuboption/stub types.RouteModuleLoader,RootRouteModuleLoader(client.tslazy-route loader signatures)BivariantComponent(the route component shape referenced byRouteComponent/RouteErrorBoundary/HydrateFallbackComponent)docs:commit softens this repo'sCLAUDE.mdfrom a forceful "SYSTEM RULE / binding system rules" framing to a calm pointer toAGENTS.md.Documentation follows the contract-altitude policy: what a symbol is / when to use it / what it throws — not implementation narration.
private/#members are intentionally left undocumented (JSR doesn't render them).Verification
deno doc --linton every entrypoint: 0 missing JSDoc on the public/protected surface.private-type-refare all external dependency types (react, react-router, esbuild, OpenTelemetry, hono) plus the intentionally-internalRoute(_server.tsx) — re-exporting third-party types is not done deliberately.deno task checkclean (lint, format, type-check).exports only — no logic or signature changes.🤖 Generated with Claude Code