Skip to content
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

types: conditional swr response #2301

Merged
merged 6 commits into from
Dec 20, 2022
Merged

Conversation

huozhi
Copy link
Member

@huozhi huozhi commented Dec 16, 2022

Resolves #1410

When fallbackData is specified for the swr hook, then:

  • it should match the Data type returning from Fetcher
  • swr hook should always return a fulfilled data
  • the isLoading always should be false

When suspense is specified for the swr hook, then:

  • swr hook should always return a fulfilled data
  • the isLoading always should be false

image

@codesandbox-ci
Copy link

codesandbox-ci bot commented Dec 16, 2022

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 344f20f:

Sandbox Source
SWR-Basic Configuration
SWR-States Configuration
SWR-Infinite Configuration
SWR-SSR Configuration

@huozhi huozhi marked this pull request as ready for review December 16, 2022 12:38
@huozhi huozhi requested a review from shuding as a code owner December 16, 2022 12:38
@huozhi huozhi mentioned this pull request Dec 20, 2022
@promer94
Copy link
Collaborator

I like the idea.
But i think we could achieve this without introducing another generic. I opened #2306 as an possible alternaive

@huozhi
Copy link
Member Author

huozhi commented Dec 20, 2022

I like the idea. But i think we could achieve this without introducing another generic. I opened #2306 as an possible alternaive

but it introduces more typing reloading for the hook, so we gonna manage more reloadings. For the new genertic type this PR only introduced one, but #2306 have more new interface with genertics need to manage?

_internal/types.ts Outdated Show resolved Hide resolved
@huozhi huozhi merged commit 2cf5b02 into vercel:main Dec 20, 2022
@huozhi huozhi deleted the type/conditional-ret branch December 20, 2022 16:42
renovate bot added a commit to Unleash/unleash that referenced this pull request Feb 12, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [swr](https://swr.vercel.app)
([source](https://togithub.com/vercel/swr)) | [`2.0.0` ->
`2.0.3`](https://renovatebot.com/diffs/npm/swr/2.0.0/2.0.3) |
[![age](https://badges.renovateapi.com/packages/npm/swr/2.0.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/swr/2.0.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/swr/2.0.3/compatibility-slim/2.0.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/swr/2.0.3/confidence-slim/2.0.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>vercel/swr</summary>

### [`v2.0.3`](https://togithub.com/vercel/swr/releases/tag/v2.0.3)

[Compare
Source](https://togithub.com/vercel/swr/compare/v2.0.2...v2.0.3)

#### Patches

- fix: parameters passed to subscribe is inconsistent with its
declaration by [@&#8203;hong24](https://togithub.com/hong24) in
[vercel/swr#2353
- fix: when inifinite key changes, should use cached pagesize instead of
initialSize by [@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2386
- fix: make compare function only compare data
([#&#8203;2375](https://togithub.com/vercel/swr/issues/2375)) by
[@&#8203;Retrospection](https://togithub.com/Retrospection) and
[@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2387
[vercel/swr#2389
- fix: initial loading state should be false with revalidation is
disabed by [@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2382
- fix: Ensure hydration matches the SSR result during streaming by
[@&#8203;shuding](https://togithub.com/shuding) in
[vercel/swr#2391

#### Chores

- ci: only run release when tags pushed by
[@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2388
- unify `-` characters in README.md by
[@&#8203;JanKaifer](https://togithub.com/JanKaifer) in
[vercel/swr#2334

#### New Contributors

- [@&#8203;hong24](https://togithub.com/hong24) made their first
contribution in
[vercel/swr#2353
- [@&#8203;Retrospection](https://togithub.com/Retrospection) made their
first contribution in
[vercel/swr#2387
- [@&#8203;JanKaifer](https://togithub.com/JanKaifer) made their first
contribution in
[vercel/swr#2334

**Full Changelog**:
vercel/swr@v2.0.2...v2.0.3

### [`v2.0.2`](https://togithub.com/vercel/swr/releases/tag/v2.0.2)

[Compare
Source](https://togithub.com/vercel/swr/compare/v2.0.1...v2.0.2)

#### Patches

- fix: delay revalidation if a key is already active and has error by
[@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2338
- fix: createCacheHelper type by
[@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2365

#### Chores

- release workflow by [@&#8203;huozhi](https://togithub.com/huozhi) in
[vercel/swr#2374,
[vercel/swr#2381,
[vercel/swr#2383,
[vercel/swr#2384,
[vercel/swr#2385

**Full Changelog**:
vercel/swr@v2.0.1...v2.0.2

### [`v2.0.1`](https://togithub.com/vercel/swr/releases/tag/v2.0.1)

[Compare Source](https://togithub.com/vercel/swr/compare/2.0.0...v2.0.1)

In this patch release, we majorly improved typing support and SWR can
infer the types based on the configuration.

- When the `suspense` option is `true`, the returned `data` will exclude
`undefined` and the `isLoading` will always be `false`.
- When the `fallbackData` option is provided, the returned `data` will
be the same type of `fallbackData`, and the `isLoading` will always be
`false`.

Here's a demo for it:


https://user-images.githubusercontent.com/4800338/213288879-ffbeeeb5-aca5-4a65-8229-69fbf9b0bf70.mp4

#### What's Changed

- types: make FullConfiguration generic by
[@&#8203;huozhi](https://togithub.com/huozhi) in
[vercel/swr#2273
- type: enforce array literal as tuple by
[@&#8203;promer94](https://togithub.com/promer94) in
[vercel/swr#2283
- Improve type test by [@&#8203;promer94](https://togithub.com/promer94)
in
[vercel/swr#2289
- update bunchee to remove the extra target cli option by
[@&#8203;huozhi](https://togithub.com/huozhi) in
[vercel/swr#2298
- fix: useSWRMutation should always use the latest fetcher by
[@&#8203;koba04](https://togithub.com/koba04) in
[vercel/swr#2290
- types: conditional swr response by
[@&#8203;huozhi](https://togithub.com/huozhi) in
[vercel/swr#2301
- fix: types properites in exports fields by
[@&#8203;koba04](https://togithub.com/koba04) in
[vercel/swr#2341
- Update license year by
[@&#8203;IcedMonk](https://togithub.com/IcedMonk) in
[vercel/swr#2344
- feat: add all mutate options support to useSWRInfinite by
[@&#8203;koba04](https://togithub.com/koba04) in
[vercel/swr#2350
- ci: add publint to check packaging on CI by
[@&#8203;koba04](https://togithub.com/koba04) in
[vercel/swr#2363

#### New Contributors

- [@&#8203;IcedMonk](https://togithub.com/IcedMonk) made their first
contribution in
[vercel/swr#2344

**Full Changelog**: vercel/swr@2.0.0...v2.0.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzAuMSIsInVwZGF0ZWRJblZlciI6IjM0LjEzMC4xIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@BoneTM
Copy link

BoneTM commented Jun 13, 2023

why the useSWRInfinite dont impl this stuff?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

typeof 'data' is always optional even with 'fallbackData' provided.
3 participants