-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add type inference for defu result #24
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
fd94b36
feat: add basic type inference for defu result
danielroe c3f0836
test: ignore type error
danielroe e063072
test: additional tests for merged types
danielroe 93ef678
test: fix test expectation
danielroe 435d918
Merge remote-tracking branch 'upstream/master' into typed-defu
danielroe File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
export type Merger = <T extends Input, K extends keyof T>( | ||
obj: T, | ||
key: keyof T, | ||
value: T[K] | ||
) => any; | ||
|
||
export type DefuFn = <Source extends Input, Defaults extends Input>( | ||
source: Source, | ||
...defaults: Defaults[] | ||
) => MergeObjects<Source, Defaults>; | ||
|
||
export interface Defu { | ||
<Source extends Input, Defaults extends Input>(source: Source, ...defaults: Defaults[]): MergeObjects< | ||
Source, | ||
Defaults | ||
>; | ||
fn: DefuFn; | ||
arrayFn: DefuFn; | ||
extend(merger?: Merger): DefuFn; | ||
} | ||
|
||
type Input = Record<string | number | symbol, any> | ||
|
||
type MergeArrays<Destination, Source> = Destination extends Array<infer DestinationType> | ||
? Source extends Array<infer SourceType> | ||
? Array<DestinationType | SourceType> | ||
: Source | Array<DestinationType> | ||
: Source | Destination | ||
|
||
type MergeObjects< | ||
Destination extends Input, | ||
Defaults extends Input | ||
> = Omit<Destination, keyof Destination & keyof Defaults> & Omit<Defaults, keyof Destination & keyof Defaults> & | ||
{ | ||
-readonly [Key in keyof Destination & keyof Defaults]: | ||
Destination[Key] extends null | ||
? Defaults[Key] extends null | ||
? null | ||
: Defaults[Key] | ||
: Defaults[Key] extends null | ||
? Destination[Key] | ||
: Merge<Destination[Key], Defaults[Key]> | ||
} | ||
|
||
export type Merge< | ||
Destination extends Input, | ||
Defaults extends Input | ||
> = | ||
// Remove explicitly null types | ||
Destination extends null | ||
? Defaults extends null | ||
? null | ||
: Defaults | ||
: Defaults extends null | ||
? Destination | ||
// Handle arrays | ||
: Destination extends Array<any> | ||
? Defaults extends Array<any> | ||
? MergeArrays<Destination, Defaults> | ||
: Destination | Defaults | ||
// Don't attempt to merge Functions, RegExps, Promises | ||
: Destination extends Function | ||
? Destination | Defaults | ||
: Destination extends RegExp | ||
? Destination | Defaults | ||
: Destination extends Promise<any> | ||
? Destination | Defaults | ||
// Don't attempt to merge Functions, RegExps, Promises | ||
: Defaults extends Function | ||
? Destination | Defaults | ||
: Defaults extends RegExp | ||
? Destination | Defaults | ||
: Defaults extends Promise<any> | ||
? Destination | Defaults | ||
// Ensure we only merge Records | ||
: Destination extends Input | ||
? Defaults extends Input | ||
? MergeObjects<Destination, Defaults> | ||
: Destination | Defaults | ||
: Destination | Defaults |
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we refactor all cases to a union type?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these are treated as extending Records so if we're not this verbose we get:
instead of: