📝 export public API option types for typedoc#4575
Open
thomas-lebeau wants to merge 1 commit intomainfrom
Open
Conversation
ActionOptions, ResourceOptions, ResourceStopOptions, FeatureOperationOptions, and FailureReason are referenced as parameter types on RumPublicApi but were not exported from the rum/rum-slim entry points. Since packages/rum-core is excluded from the typedoc config, those types had no generated pages.
gogusarov
approved these changes
May 8, 2026
🎉 All green!❄️ No new flaky tests detected 🎯 Code Coverage (details) 🔗 Commit SHA: 816dba9 | Docs | Datadog PR Page | Give us feedback! |
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.
Motivation
The generated typedoc API reference (e.g.
DatadogRum.startResource) is missing dedicated pages for several option types passed to public methods —ResourceStopOptions,ResourceOptions,ActionOptions,FeatureOperationOptions, andFailureReason. Parameter types render as bare names with no link, so users can't discover the available fields.Root cause:
typedoc.jsonexcludespackages/rum-core, so any type referenced fromRumPublicApimust be re-exported through therum/rum-slimentry points to get a generated page. These five types weren't.Changes
packages/rum-core/src/index.ts— exportActionOptions,ResourceOptions,ResourceStopOptions,FeatureOperationOptions,FailureReason.packages/rum/src/entries/main.tsandpackages/rum-slim/src/entries/main.ts— re-export the same five types so typedoc resolves them.No runtime change; pure type re-exports.
Test instructions
Build and serve the docs locally:
Then in the browser, browse to
DatadogRum(under both@datadog/browser-rumand@datadog/browser-rum-slim) and click through the parameter types of:startResource→ResourceOptionsstopResource→ResourceStopOptionsstartAction/stopAction→ActionOptionsstartFeatureOperation/succeedFeatureOperation/failFeatureOperation→FeatureOperationOptionsfailFeatureOperation(second arg) →FailureReasonEach should now navigate to its own page describing the available fields, instead of rendering as a non-clickable type name.
Checklist