Define strict type for EdgeProps.pathOptions #5650
Open
+3
−2
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.
Summary
Improves type safety for the
pathOptionsprop inEdgePropsby replacing theanytype with a newInferPathOptionsutility type that properly infers the path options from the edge type.Changes
InferPathOptions<E>utility type that extracts thepathOptionstype from an edgeEdgeProps.pathOptionsto useInferPathOptions<EdgeType>instead ofanypathOptionsExample
With the updated typing, custom edges automatically provide strongly typed pathOptions.
For example:
When using EdgeProps, the pathOptions property is now inferred as:
This ensures that consumers get accurate autocomplete and type checking for their custom edge options.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.