Repository navigation
Fix type errors with maplibre-gl 6.0–6.2 - #27
Merged
Merged
Conversation
This file contains hidden or 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
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.
Problem
The peer dependency allows
maplibre-gl >=6.0.0, but the published typings only compile from 6.3.0 on.StyleControlEventTypeusedEvent<"style.set">, and maplibre'sEventclass only became generic in 6.3.0. TypeScript projects on 6.0–6.2 withoutskipLibCheckfail to build with:Runtime behavior was never affected. CI didn't catch it because it only runs against the locked version (6.9.1).
Changes
Eventin thestyle.setevent type.Evented<…>is already generic in 6.0.0, socontrol.on("style.set", e => e.style)stays fully typed. The only difference is thate.typeis now typed asstringinstead of the literal"style.set".maplibre-glv6.Fixing the typings instead of raising the peer range to
>=6.3.0keeps users on 6.0–6.2 installable without--legacy-peer-deps.Testing
Typecheck and tests pass against
maplibre-gl6.0.0, 6.2.0, 6.3.0, 6.9.1 (locked) and 6.12.0 (latest). Before this change, typecheck failed on 6.0.0–6.2.0.