Location type discriminators#6000
Merged
dylans merged 4 commits intoianstormtaylor:mainfrom Jan 10, 2026
Merged
Conversation
🦋 Changeset detectedLatest commit: 660c4b9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
dylans
approved these changes
Jan 10, 2026
Merged
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.
Description
Adds
Location.isPath,Location.isPoint,Location.isRange, and alsoLocation.isSpanas type-aware discriminators.Essentially #5982 but for Locations. (Except I had the decency to include unit tests this time.)
Also fixes
Path.isPathto correctly reject arrays containing a mix of numbers and other values and adds a unit test for it.Issue
Performance improvement. Differentiating between Locations doesn't need exhaustive type verification.
Context
Spans are not technically Locations (they are location-like but only accepted by
Editor#nodes, which is only passed a Span byEditor#previousandEditor#next--I'm uncertain if its used by any users or even meant to be) but I figured they should be included in this.Location.isSpanaccepts arguments of typeLocation | Spanwhereas the others accept solelyLocationso it needs to be checked for first if its a possibility.In theory if a user implements a custom extension to either
PointorRangethat implements only some of the properties of the other then some false positives could be thrown, but that would be an insane thing to do I think.Unfortunately because of one (1) call in each of
slate-domandslate-reactthis needs a peerDependency bump 😅 If I should add it to this PR just lmkChecks
yarn test.yarn lint. (Fix errors withyarn fix.)yarn start.)yarn changeset add.)