Export a *type* for BufferedMetricsLogger#120
Merged
Conversation
Even though we started generating TypeScript types from the JSDoc a while back, it turns out `BufferedMetricsLogger` was getting exported as a value and not a type, which technically works in TS, but is definitely not what you want. This changes up our syntax a bit to get the compiler to do the right thing, and adds a basic test of the types to make sure we don't regress. Fixes #119.
This package is compatible with Node.js 12, and so needs types from Node.js 12 (loading newer types causes TypeScript tests to error).
Mr0grog
force-pushed
the
119-if-you-want-types-you-probably-want-actual-types
branch
from
dd60e02 to
74fc9ae
Compare
Collaborator
Author
|
OK, I’m going to go ahead and merge this, then publish a v0.11.3a1 pre-release for users to verify this fix with. |
Mr0grog
deleted the
119-if-you-want-types-you-probably-want-actual-types
branch
Mr0grog
added a commit
that referenced
this pull request
Nov 12, 2024
In #120, I added a test of our built types. Since we do a clean build of the types before publishing, we should also do a final check of those build results just to avoid any accidental issues for things that weren't fully checked (usually CI protects us here, but since we publish manually, a final check is useful!).
Mr0grog
added a commit
that referenced
this pull request
Nov 17, 2024
In #120, I added a test of our built types. Since we do a clean build of the types before publishing, we should also do a final check of those build results just to avoid any accidental issues for things that weren't fully checked (usually CI protects us here, but since we publish manually, a final check is useful!).
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.
Even though we started generating TypeScript types from the JSDoc a while back, it turns out
BufferedMetricsLoggerwas getting exported as a value and not a type, which technically works in TS, but is definitely not what you want. This changes up our syntax a bit to get the compiler to do the right thing, and adds a basic test of the types to make sure we don't regress.Fixes #119.
Worth thinking about briefly before landing: are there other types we should be taking more care to export here?