fix: update extraState property in serializer typedefs #6057
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 basics
npm run format
andnpm run lint
The details
Resolves
In the JSON serializer there are two typedefs with a property called
extra-state
. This breaks the hell out of the typescript definitions because the compiler can't parse the jsdoc. e.g. the early commits here #6051 (and also last quarter had to be hand-fixed)Proposed Changes
Adds quotations around the property. Properties with dashes can only be accessed with bracket notation and quotes, so adding the quotes helps the TypeScript parser.
I think this property probably should have been called extraState from the beginning. Is it worth changing now? It's probably somewhat annoying for an external developer because they have to use bracket notation. If we were to change it then asap would be better. We could probably handle both values in the serializer to avoid making that a breaking change? Not sure if it's worth it, would like your input Beka.
Behavior Before Change
Behavior After Change
Reason for Changes
Test Coverage
Tested this fixes the TypeScript definition generation problems; the output is no longer malformed with this change.
Documentation
Additional Information