fix: generate types from JSDoc #377
Merged
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
Was removed in v5
wkillerud
commented
May 14, 2024
| @@ -91,15 +121,15 @@ export default class PodiumClient extends EventEmitter { | |||
| }); | |||
|
|
|||
| this.#metrics = new Metrics(); | |||
| this.#metrics.on('error', error => { | |||
| this.#metrics.on('error', (error) => { | |||
| log.error( | |||
| 'Error emitted by metric stream in @podium/client module', | |||
| error, | |||
| ); | |||
| }); | |||
|
|
|||
| this[Symbol.iterator] = () => ({ | |||
There was a problem hiding this comment.
I don't think this Symbol.iterator API is possible to type
| @@ -227,6 +252,7 @@ export default class PodletClientContentResolver { | |||
| if (outgoing.redirectable && statusCode >= 300) { | |||
| outgoing.redirect = { | |||
| statusCode, | |||
| // @ts-expect-error TODO: look into what happens if the podlet returns more than one location header | |||
There was a problem hiding this comment.
TS highlighted this as a potential error, but I didn't want to make a decision there now
|
|
||
| /** | ||
| * Filter assets array based on scope. | ||
| * If scope property is not present, asset will be included (backwards compatibility) | ||
| * If scope property is set to "all", asset will be included. | ||
| * If scope is set to "content" and asset scope property is set to "fallback", asset will not be included | ||
| * If scope is set to "fallback" and asset scope property is set to "content", asset will not be included | ||
| * @template {import("@podium/utils").AssetCss | import("@podium/utils").AssetJs} T[] |
There was a problem hiding this comment.
Replaced with generics so the type is kept untouched on the Response class itself
|
Tested with local linking via |
Reexport some types that were missing from the client export
|
🎉 This PR is included in version 5.0.21 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Expand the typing/JSDoc internally in the module as well