feat: improve the VertexMixin type #211
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
The methods defined in the `VertexMixin` type were not documented. The signature of the `insertVertex` method was using a spread `any` parameter, so it provided no guidance nor guard. Instead, the type now declares the various form of the methods with the right signature.
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 methods defined in the
VertexMixintype were not documented.The signature of the
insertVertexmethod was using a spreadanyparameter, so it provided no guidance nor guard.Instead, the type now declares the various form of the methods with the right signature.
Notes
The new
VertexParameterstype is inspired by https://github.com/jwyGithub/maxGraph-composition-api/blob/cdf7cf0898285e39e2e51c4efa9503f90288f967/packages/graph-draw/src/index.ts#L15