fix(SVGCursorDescriptor): improve CursorSVG typing #705
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.
Context
CursorSVG
had a implicit type that did not reflect, that cursors for new tool names can be added.registerCursor
can add any string as toolname toCursorSVG
.svgCursorNames
has a similar problem. It only returns the initial cursor names.Maybe it should be a function instead of a variable to return the current keys of
CursorSVG
.I did not changed it because I did not want to risk changing the public API on my first PR here. :)
Changes & Results
CursorSVG
has a broader type.Small refactoring in
getDefinedSVGCursorDescriptor
. Should not affect functionality.Testing
Only typing change. No change in runtime behavior.
Checklist
PR
semantic-release format and guidelines.
Code
[] My code has been well-documented (function documentation, inline comments,
etc.)
I have run the
yarn build:update-api
to update the API documentation, and havecommitted the changes to this PR. (Read more here https://www.cornerstonejs.org/docs/contribute/update-api)
Public Documentation Updates
additions or removals.
Tested Environment