fix(types): correct FuseSortFunctionMatch key type from string to object#815
Open
kaigritun wants to merge 1 commit intokrisk:mainfrom
Open
fix(types): correct FuseSortFunctionMatch key type from string to object#815kaigritun wants to merge 1 commit intokrisk:mainfrom
kaigritun wants to merge 1 commit intokrisk:mainfrom
Conversation
The key property in FuseSortFunctionMatch was incorrectly typed as string, but the actual runtime value is an object created by createKey() containing: - path: string[] - the path segments - id: string - the key identifier - weight: number - the weight - src: string | string[] - the original source key - getFn: Function | null - optional custom getter This adds a new FuseKey<T> type and updates FuseSortFunctionMatch to use it. Fixes krisk#811
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
keyproperty inFuseSortFunctionMatchis typed asstring, but the actual runtime value is an object created bycreateKey()inKeyStore.js.As reported in #811, when using
sortFn, the logged key shows:Solution
This PR:
Adds a new
FuseKey<T>type that correctly represents the key object structure:path: string[]- the path segmentsid: string- the key identifier (joined path)weight: number- the assigned weightsrc: string | string[]- the original source key namegetFn- optional custom getter functionUpdates
FuseSortFunctionMatch.keyto useFuseKey<any>instead ofstringUpdates the JSDoc example to reflect the actual object structure
Testing
All existing tests pass (121 tests).
Fixes #811