fix(types): correct CommonJS export in @fastify/otel typings #30
Conversation
This file contains 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
The typescript typings were exporting using the ESM style exports, but this is a CJS module, so the exports were not resolving correctly. This switches the type export to use `export = ` syntax instead which works for ESM consumers as well as CJS consumers. Fixes fastify#24 Signed-off-by: Bret Comnes <[email protected]>
metcoder95
reviewed
Mar 17, 2025
Eomm
reviewed
Mar 17, 2025
| @@ -16,5 +16,4 @@ declare class FastifyOtelInstrumentation<Config extends FastifyOtelInstrumentati | |||
| plugin (): (instance: FastifyInstance, opts: FastifyOtelOptions, done: (err?: Error) => void) => void | |||
| } | |||
|
|
|||
| export default FastifyOtelInstrumentation | |||
| export { FastifyOtelInstrumentation } | |||
| export = FastifyOtelInstrumentation | |||
There was a problem hiding this comment.
Good spot!
Is this enough? Should we export the default as other plugins do?
There was a problem hiding this comment.
I don't recall spotting other issues on other plugins, but also I import them into register in an fp so maybe I missed the issues. If it's an issue here, then it's also presumably an issue elsewhere. There might be other places where this is addressed, would need to investigate.
There was a problem hiding this comment.
Should we add some tests using eg tsd?
Yes, I will add some when I find time on an evening. Anyone feel free to beat me to it. |
bcomnes
commented
Mar 17, 2025
| @@ -16,5 +16,4 @@ declare class FastifyOtelInstrumentation<Config extends FastifyOtelInstrumentati | |||
| plugin (): (instance: FastifyInstance, opts: FastifyOtelOptions, done: (err?: Error) => void) => void | |||
| } | |||
|
|
|||
| export default FastifyOtelInstrumentation | |||
| export { FastifyOtelInstrumentation } | |||
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.
The typescript typings were exporting using the ESM style exports, but this is a CJS module, so the exports were not resolving correctly. This switches the type export to use
export =syntax instead which works for ESM consumers as well as CJS consumers.Fixes #24
Checklist
npm run testandnpm run benchmarkdocumentation is changed or addedand the Code of conduct