feat(*): add OmitKeyof to Omit object by object's keys strictly
#7139
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 155859b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 155859b:
|
manudeli
commented
Mar 19, 2024
| UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, | ||
| 'placeholderData' | 'suspense' |
There was a problem hiding this comment.
This unnecessary suspense field could be removed by OmitKeyof with correct type error
manudeli
changed the title
manudeli
changed the title
OmitKeyof to Omitting keys strictly
manudeli
changed the title
OmitKeyof to Omitting keys strictlyOmitKeyof to Omit keys strictly
manudeli
changed the title
OmitKeyof to Omit keys strictlyOmitKeyof to Omit object by object's keys strictly
TkDodo
approved these changes
Mar 22, 2024
1 task
manudeli
added a commit
to toss/suspensive
that referenced
this pull request
Mar 27, 2024
# Overview
<!--
A clear and concise description of what this pr is about.
-->
related with TanStack/query#7139
This change update `OmitKeyof` to validate Omitting keys should be keyof
Omitted Object Type
As shown below, the inconvenience of having to manually remove
unnecessary fields can be identified early on at the type level with
`OmitKeyof`.
### Motivatings
- https://github.com/TanStack/query/pull/6907/files
- TanStack/query#7139 (comment)
### Expectation
I made test-d to type-test `OmitKeyof`
- For complex types using `Omit`, I want to reduce the difficulty of
library maintenance for it.
- `OmitKeyof` provide autocomplete by extending keyof TObject
- `OmitKeyof` check strictly second type parameter of it by extending
keyof TObject
- `OmitKeyof` prevent library contributors make misspell like queryTey
or qeuryKey
- Library users can be supplied with stable types consistently
## PR Checklist
- [x] I did below actions if need
1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
manudeli
added a commit
to toss/suspensive
that referenced
this pull request
Aug 3, 2024
# Overview
<!--
A clear and concise description of what this pr is about.
-->
related with TanStack/query#7139
This change update `OmitKeyof` to validate Omitting keys should be keyof
Omitted Object Type
As shown below, the inconvenience of having to manually remove
unnecessary fields can be identified early on at the type level with
`OmitKeyof`.
### Motivatings
- https://github.com/TanStack/query/pull/6907/files
- TanStack/query#7139 (comment)
### Expectation
I made test-d to type-test `OmitKeyof`
- For complex types using `Omit`, I want to reduce the difficulty of
library maintenance for it.
- `OmitKeyof` provide autocomplete by extending keyof TObject
- `OmitKeyof` check strictly second type parameter of it by extending
keyof TObject
- `OmitKeyof` prevent library contributors make misspell like queryTey
or qeuryKey
- Library users can be supplied with stable types consistently
## PR Checklist
- [x] I did below actions if need
1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
manudeli
added a commit
to toss/suspensive
that referenced
this pull request
Aug 3, 2024
# Overview
<!--
A clear and concise description of what this pr is about.
-->
related with TanStack/query#7139
This change update `OmitKeyof` to validate Omitting keys should be keyof
Omitted Object Type
As shown below, the inconvenience of having to manually remove
unnecessary fields can be identified early on at the type level with
`OmitKeyof`.
### Motivatings
- https://github.com/TanStack/query/pull/6907/files
- TanStack/query#7139 (comment)
### Expectation
I made test-d to type-test `OmitKeyof`
- For complex types using `Omit`, I want to reduce the difficulty of
library maintenance for it.
- `OmitKeyof` provide autocomplete by extending keyof TObject
- `OmitKeyof` check strictly second type parameter of it by extending
keyof TObject
- `OmitKeyof` prevent library contributors make misspell like queryTey
or qeuryKey
- Library users can be supplied with stable types consistently
## PR Checklist
- [x] I did below actions if need
1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
manudeli
added a commit
to toss/suspensive
that referenced
this pull request
Aug 3, 2024
# Overview
<!--
A clear and concise description of what this pr is about.
-->
related with TanStack/query#7139
This change update `OmitKeyof` to validate Omitting keys should be keyof
Omitted Object Type
As shown below, the inconvenience of having to manually remove
unnecessary fields can be identified early on at the type level with
`OmitKeyof`.
### Motivatings
- https://github.com/TanStack/query/pull/6907/files
- TanStack/query#7139 (comment)
### Expectation
I made test-d to type-test `OmitKeyof`
- For complex types using `Omit`, I want to reduce the difficulty of
library maintenance for it.
- `OmitKeyof` provide autocomplete by extending keyof TObject
- `OmitKeyof` check strictly second type parameter of it by extending
keyof TObject
- `OmitKeyof` prevent library contributors make misspell like queryTey
or qeuryKey
- Library users can be supplied with stable types consistently
## PR Checklist
- [x] I did below actions if need
1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
manudeli
added a commit
to toss/suspensive
that referenced
this pull request
Aug 3, 2024
# Overview
<!--
A clear and concise description of what this pr is about.
-->
related with TanStack/query#7139
This change update `OmitKeyof` to validate Omitting keys should be keyof
Omitted Object Type
As shown below, the inconvenience of having to manually remove
unnecessary fields can be identified early on at the type level with
`OmitKeyof`.
### Motivatings
- https://github.com/TanStack/query/pull/6907/files
- TanStack/query#7139 (comment)
### Expectation
I made test-d to type-test `OmitKeyof`
- For complex types using `Omit`, I want to reduce the difficulty of
library maintenance for it.
- `OmitKeyof` provide autocomplete by extending keyof TObject
- `OmitKeyof` check strictly second type parameter of it by extending
keyof TObject
- `OmitKeyof` prevent library contributors make misspell like queryTey
or qeuryKey
- Library users can be supplied with stable types consistently
## PR Checklist
- [x] I did below actions if need
1. I read the [Contributing
Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md)
2. I added documents and tests.
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.
This change add
OmitKeyofto validate Omitting keys should be keyof Omitted Object TypeAs shown below, the inconvenience of having to manually remove unnecessary fields can be identified early on at the type level with
OmitKeyof.Motivatings
OmitKeyofto Omit object by object's keys strictly #7139 (comment)Expectation
I made test-d to type-test
OmitKeyofin https://github.com/TanStack/query/pull/7139/files#diff-e6421be8af92bef480137fd70c8e935fd1975d73ae3a75f393893de5542e2a41Omit, I want to reduce the difficulty of library maintenance for it.OmitKeyofprovide autocomplete by extending keyof TObjectOmitKeyofcheck strictly second type parameter of it by extending keyof TObjectOmitKeyofprevent library contributors make misspell like queryTey or qeuryKey