feat(types): cheaper WithRequired

[Andarist]

To the best of my understanding - this should work just fine but I didn't test it "thoroughly" with TanStack Query.

I'm opening this PR mostly because I got curious if it will pass your CI jobs. If it does though - it might be worth merging. This reduces 3 mapped types to just one :)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
query	⬜️ Ignored (Inspect)			Jul 21, 2023 9:17am

[codesandbox-ci]

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 db30de1:

Sandbox	Source
@tanstack/query-example-react-basic-typescript	Configuration
@tanstack/query-example-solid-basic-typescript	Configuration
@tanstack/query-example-svelte-basic	Configuration
@tanstack/query-example-vue-basic	Configuration

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (5188ae3) 91.79% compared to head (644d223) 91.79%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4922   +/-   ##
=======================================
  Coverage   91.79%   91.79%           
=======================================
  Files         101      101           
  Lines        3890     3890           
  Branches      974      974           
=======================================
  Hits         3571     3571           
  Misses        298      298           
  Partials       21       21           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[DamianOsipiuk]

@Andarist Any idea how much faster this one performs?
Or maybe do you have an idea how to measure it?

Seems to be working as intended, but looks weird 😂

[Andarist]

Hard to tell really. It's "theoretically" faster by the sole virtue of using fewer mapped types. The best way to test this would be to run tsc --extendedDiagnostics with both versions in a project that is using this library a lot.

[DamianOsipiuk]

So i ran a couple of runs on vue-query which seems to be using more of WithRequired with added diagnostics, and clearing builds between runs.

It seems like it improves the time by ~0.05s and memory usage by ~5000K.

Of course those tests were not very scientific 🧑‍🔬 🔫 But it seems it does make a difference.
I would be curious about performance benefit in a large app.

@TkDodo Should we merge it?

[Andarist]

It also might be worth checking out the functionality of this code in pre-4.8 - since this is a version that changed some rules around T & {}

[TkDodo]

Good point, we want to support 4.7 and onwards in v5

[Andarist]

Note that I did recheck this (and everything looks alright) - it's just that I'm advising extra caution because of this TS 4.8 change.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit db30de1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

🟥 Failed Commands
nx affected --targets=test:eslint,test:lib,test:types,test:build

✅ Successfully ran 1 target

• nx affected --targets=test:lib --base=684ed14693905b233cfb7b06d9eed8f989c6374c

---

Sent with 💌 from NxCloud.