feat: Add AtLeastOne type #171
Merged
Conversation
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
Drodevbar
requested review from
kibertoad,
drdaemos,
CarlosGamero and
a team
as code owners
Drodevbar
force-pushed
the
feat/add-at-least-one-type
branch
from
485154b to
2749d2e
Compare
Drodevbar
force-pushed
the
feat/add-at-least-one-type
branch
from
8a2585e to
aab5016
Compare
kibertoad
reviewed
Dec 13, 2024
| @@ -0,0 +1,2 @@ | |||
| // can be used when you want to make at least one key of an object required | |||
| export type AtLeastOne<T, U = { [K in keyof T]: Pick<T, K> }> = Partial<T> & U[keyof U] | |||
There was a problem hiding this comment.
can you add documentation for it to readme.md?
There was a problem hiding this comment.
I've added them to docs/custom-types.md as I see we have some documents already there. I've included the existing types that haven't been documented so far.
kibertoad
reviewed
Dec 13, 2024
| const testCase2: AtLeastOne<TestType> = { b: 1 } | ||
|
|
||
| assertType<{ a: string; b?: number }>(testCase1) | ||
| assertType<{ a?: string; b: number }>(testCase2) |
There was a problem hiding this comment.
can you also add negative case?
There was a problem hiding this comment.
Added negative test ✅
I've also enabled typecheck as by default vitest has it disabled - please see vitest.config.mts
Drodevbar
force-pushed
the
feat/add-at-least-one-type
branch
from
c22d0c6 to
4a9c017
Compare
kibertoad
approved these changes
Dec 13, 2024
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.
Changes
I find this util type useful when I have a function that requires me to pass at least one param. Thanks to it, I don't have to manually verify whether one of them was passed, but TS can do the work.
Checklist
major,minor,patchorskip-release