Include MultiLineString output type for greatCircle
module
#1928
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.
This PR updates the Typescript type definitions and corresponding docs for the
greatCircle
function to include the possibility of returning aMultiLineString
when the input spans the antimeridian. This is described as expected behavior in this issue. Without this fix, Typescript will return an error if you try to test, for example:Typescript complains:
This condition will always return 'false' since the types '"LineString" | undefined' and '"MultiLineString"' have no overlap.