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.

Sign up for GitHub

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

Jump to bottom

docs: add suspensive react query to community projects #7846

Merged
merged 2 commits into from
Aug 5, 2024
Merged

docs: add suspensive react query to community projects #7846

merged 2 commits into from
Aug 5, 2024

Conversation

gwansikk
Copy link
Contributor

@gwansikk gwansikk commented Aug 4, 2024 •
edited
Loading

Hello! I am the maintainer of @suspensive.

The @suspensive/react-query package now officially supports @tanstack/react-query v5, and we would like to add it to the v5 Community Projects.

You can find more details in the documentation: Support both TanStack Query v4 and 5

1️⃣ Since @suspensive/react-query@2.2.0, it supports both @tanstack/react-query v4 and v5.

@suspensive/react-query is composed of @suspensive/react-query-4 and @suspensive/react-query-5, which provide interfaces corresponding to the version of @tanstack/react-query. It detects the installed version of @tanstack/react-query in the user's environment and automatically provides the compatible interface.

2️⃣ It is a good method for migrating to @tanstack/react-query v5.

  • @suspensive/react-query is a community resource for @tanstack/react-query v4.

Hooks such as useSuspenseQuery, useSuspenseQueries, and useSuspenseInfiniteQuery, which were not originally available in @tanstack/react-query v4, can now be used. Currently, these hooks are officially provided in @tanstack/react-query v5, making it a good alternative for migrating from @tanstack/react-query v4 to v5.

  • We encourage users to migrate to the APIs officially provided in @tanstack/react-query v5.

By using @suspensive/react-query, users who are leveraging features not provided in @tanstack/react-query v4 (e.g., Suspense Query, queryOptions) can easily migrate to the v5 API. We re-export the @tanstack/react-query v5 API to inform users about the transition.

Example:

/**
 * This feature is officially supported in \@tanstack/react-query@5, You can proceed with the migration.
 * @deprecated Use `queryOptions` from \@tanstack/react-query@5
 * @example
 * ```diff
 * - import { queryOptions } from '@suspensive/react-query'
 * + import { queryOptions } from '@tanstack/react-query'
 * ```
 */
export const queryOptions = original_queryOptions

@gwansikk @manudeli
docs: add react suspensive react query to community projects
6fb5c11 
Co-authored-by: Jonghyeon Ko <61593290+manudeli@users.noreply.github.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 4, 2024
@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Aug 4, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4f2402e. 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 2 targets

Sent with 💌 from NxCloud.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Aug 4, 2024 •
edited
Loading

commit: 4f2402e

pnpm add https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@7846

pnpm add https://pkg.pr.new/@tanstack/angular-query-experimental@7846

pnpm add https://pkg.pr.new/@tanstack/eslint-plugin-query@7846

pnpm add https://pkg.pr.new/@tanstack/query-async-storage-persister@7846

pnpm add https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@7846

pnpm add https://pkg.pr.new/@tanstack/query-core@7846

pnpm add https://pkg.pr.new/@tanstack/query-devtools@7846

pnpm add https://pkg.pr.new/@tanstack/query-persist-client-core@7846

pnpm add https://pkg.pr.new/@tanstack/query-sync-storage-persister@7846

pnpm add https://pkg.pr.new/@tanstack/react-query@7846

pnpm add https://pkg.pr.new/@tanstack/react-query-devtools@7846

pnpm add https://pkg.pr.new/@tanstack/react-query-next-experimental@7846

pnpm add https://pkg.pr.new/@tanstack/react-query-persist-client@7846

pnpm add https://pkg.pr.new/@tanstack/solid-query@7846

pnpm add https://pkg.pr.new/@tanstack/solid-query-devtools@7846

pnpm add https://pkg.pr.new/@tanstack/solid-query-persist-client@7846

pnpm add https://pkg.pr.new/@tanstack/svelte-query@7846

pnpm add https://pkg.pr.new/@tanstack/svelte-query-devtools@7846

pnpm add https://pkg.pr.new/@tanstack/svelte-query-persist-client@7846

pnpm add https://pkg.pr.new/@tanstack/vue-query@7846

pnpm add https://pkg.pr.new/@tanstack/vue-query-devtools@7846

Open in Stackblitz

More templates

@gwansikk gwansikk mentioned this pull request Aug 4, 2024
Closed
@gwansikk gwansikk changed the title docs: add react suspensive react query to community projects docs: add suspensive react query to community projects Aug 4, 2024
@gwansikk gwansikk marked this pull request as ready for review August 4, 2024 13:52
@TkDodo TkDodo merged commit 075ba1c into TanStack:main Aug 5, 2024
6 checks passed
@gwansikk gwansikk deleted the docs/suspensive branch August 5, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@manudeli manudeli manudeli left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gwansikk @manudeli @TkDodo