Skip to content

Commit d040eaa

Browse files
birkskyumautofix-ci[bot]
birkskyum
and
autofix-ci[bot]
authored
fix(solid-query): deprecate create in favor of use, and add full docs (#8950)
* Revert "fix(solid-query): keep solid-query on just `createQuery` syntax (#8947)" This reverts commit 4e45d7c. * Revert "fix(solid-query): use QueryClient from query-core (#8943)" This reverts commit 8f84606. * deprecate create types * add proper deprecation * add solid reference * add solid guides * request waterfall and advanced ssr * client-state * ci: apply automated fixes * ci: apply automated fixes (attempt 2/3) --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 477faea commit d040eaa

File tree

84 files changed

+1435
-679
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1435
-679
lines changed

‎docs/config.json

Lines changed: 201 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,143 @@
326326
}
327327
]
328328
},
329+
{
330+
"label": "solid",
331+
"children": [
332+
{
333+
"label": "Important Defaults",
334+
"to": "framework/solid/guides/important-defaults"
335+
},
336+
{
337+
"label": "Queries",
338+
"to": "framework/solid/guides/queries"
339+
},
340+
{
341+
"label": "Query Keys",
342+
"to": "framework/solid/guides/query-keys"
343+
},
344+
{
345+
"label": "Query Functions",
346+
"to": "framework/solid/guides/query-functions"
347+
},
348+
{
349+
"label": "Query Options",
350+
"to": "framework/solid/guides/query-options"
351+
},
352+
{
353+
"label": "Network Mode",
354+
"to": "framework/solid/guides/network-mode"
355+
},
356+
{
357+
"label": "Parallel Queries",
358+
"to": "framework/solid/guides/parallel-queries"
359+
},
360+
{
361+
"label": "Dependent Queries",
362+
"to": "framework/solid/guides/dependent-queries"
363+
},
364+
{
365+
"label": "Background Fetching Indicators",
366+
"to": "framework/solid/guides/background-fetching-indicators"
367+
},
368+
{
369+
"label": "Window Focus Refetching",
370+
"to": "framework/solid/guides/window-focus-refetching"
371+
},
372+
{
373+
"label": "Disabling/Pausing Queries",
374+
"to": "framework/solid/guides/disabling-queries"
375+
},
376+
{
377+
"label": "Query Retries",
378+
"to": "framework/solid/guides/query-retries"
379+
},
380+
{
381+
"label": "Paginated Queries",
382+
"to": "framework/solid/guides/paginated-queries"
383+
},
384+
{
385+
"label": "Infinite Queries",
386+
"to": "framework/solid/guides/infinite-queries"
387+
},
388+
{
389+
"label": "Initial Query Data",
390+
"to": "framework/solid/guides/initial-query-data"
391+
},
392+
{
393+
"label": "Placeholder Query Data",
394+
"to": "framework/solid/guides/placeholder-query-data"
395+
},
396+
{
397+
"label": "Mutations",
398+
"to": "framework/solid/guides/mutations"
399+
},
400+
{
401+
"label": "Query Invalidation",
402+
"to": "framework/solid/guides/query-invalidation"
403+
},
404+
{
405+
"label": "Invalidation from Mutations",
406+
"to": "framework/solid/guides/invalidations-from-mutations"
407+
},
408+
{
409+
"label": "Updates from Mutation Responses",
410+
"to": "framework/solid/guides/updates-from-mutation-responses"
411+
},
412+
{
413+
"label": "Optimistic Updates",
414+
"to": "framework/solid/guides/optimistic-updates"
415+
},
416+
{
417+
"label": "Query Cancellation",
418+
"to": "framework/solid/guides/query-cancellation"
419+
},
420+
{
421+
"label": "Scroll Restoration",
422+
"to": "framework/solid/guides/scroll-restoration"
423+
},
424+
{
425+
"label": "Filters",
426+
"to": "framework/solid/guides/filters"
427+
},
428+
{
429+
"label": "Request Waterfalls",
430+
"to": "framework/solid/guides/request-waterfalls"
431+
},
432+
{
433+
"label": "Prefetching",
434+
"to": "framework/solid/guides/prefetching"
435+
},
436+
{
437+
"label": "SSR",
438+
"to": "framework/solid/guides/ssr"
439+
},
440+
{
441+
"label": "Advanced SSR",
442+
"to": "framework/solid/guides/advanced-ssr"
443+
},
444+
{
445+
"label": "Caching",
446+
"to": "framework/solid/guides/caching"
447+
},
448+
{
449+
"label": "Default Query Fn",
450+
"to": "framework/solid/guides/default-query-function"
451+
},
452+
{
453+
"label": "Suspense",
454+
"to": "framework/solid/guides/suspense"
455+
},
456+
{
457+
"label": "Testing",
458+
"to": "framework/solid/guides/testing"
459+
},
460+
{
461+
"label": "Does this replace state managers?",
462+
"to": "framework/angular/guides/does-this-replace-client-state"
463+
}
464+
]
465+
},
329466
{
330467
"label": "vue",
331468
"children": [
@@ -757,8 +894,44 @@
757894
"label": "solid",
758895
"children": [
759896
{
760-
"label": "createQuery",
761-
"to": "framework/solid/reference/createQuery"
897+
"label": "useQuery",
898+
"to": "framework/solid/reference/useQuery"
899+
},
900+
{
901+
"label": "useQueries",
902+
"to": "framework/solid/reference/useQueries"
903+
},
904+
{
905+
"label": "useInfiniteQuery",
906+
"to": "framework/solid/reference/useInfiniteQuery"
907+
},
908+
{
909+
"label": "useMutation",
910+
"to": "framework/solid/reference/useMutation"
911+
},
912+
{
913+
"label": "useIsFetching",
914+
"to": "framework/solid/reference/useIsFetching"
915+
},
916+
{
917+
"label": "useIsMutating",
918+
"to": "framework/solid/reference/useIsMutating"
919+
},
920+
{
921+
"label": "useMutationState",
922+
"to": "framework/solid/reference/useMutationState"
923+
},
924+
{
925+
"label": "queryOptions",
926+
"to": "framework/solid/reference/queryOptions"
927+
},
928+
{
929+
"label": "infiniteQueryOptions",
930+
"to": "framework/solid/reference/infiniteQueryOptions"
931+
},
932+
{
933+
"label": "hydration",
934+
"to": "framework/solid/reference/hydration"
762935
}
763936
]
764937
},
@@ -844,6 +1017,19 @@
8441017
}
8451018
]
8461019
},
1020+
{
1021+
"label": "solid",
1022+
"children": [
1023+
{
1024+
"label": "TkDodo's Blog",
1025+
"to": "framework/solid/community/tkdodos-blog"
1026+
},
1027+
{
1028+
"label": "Community Projects",
1029+
"to": "framework/solid/community/community-projects"
1030+
}
1031+
]
1032+
},
8471033
{
8481034
"label": "vue",
8491035
"children": [
@@ -1131,6 +1317,19 @@
11311317
}
11321318
]
11331319
},
1320+
{
1321+
"label": "solid",
1322+
"children": [
1323+
{
1324+
"label": "broadcastQueryClient (Experimental)",
1325+
"to": "framework/solid/plugins/broadcastQueryClient"
1326+
},
1327+
{
1328+
"label": "createPersister (Experimental)",
1329+
"to": "framework/solid/plugins/createPersister"
1330+
}
1331+
]
1332+
},
11341333
{
11351334
"label": "vue",
11361335
"children": [

‎docs/framework/solid/community/community-projects.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: community-projects
3+
title: Community Projects
4+
ref: docs/framework/react/community/community-projects.md
5+
replace: { 'React Query': 'TanStack Query' }
6+
---

‎docs/framework/solid/community/tkdodos-blog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: tkdodos-blog
3+
title: TkDodo's Blog
4+
ref: docs/framework/react/community/tkdodos-blog.md
5+
---

‎docs/framework/solid/guides/advanced-ssr.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: advanced-ssr
3+
title: Advanced Server Rendering
4+
---
5+
6+
Will come soon

‎docs/framework/solid/guides/background-fetching-indicators.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: background-fetching-indicators
3+
title: Background Fetching Indicators
4+
ref: docs/framework/react/guides/background-fetching-indicators.md
5+
replace: { 'useMutation[(]': 'useMutation(() => ' }
6+
---

‎docs/framework/solid/guides/caching.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: caching
3+
title: Caching Examples
4+
ref: docs/framework/react/guides/caching.md
5+
---

‎docs/framework/solid/guides/default-query-function.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: default-query-function
3+
title: Default Query Function
4+
ref: docs/framework/react/guides/default-query-function.md
5+
replace:
6+
{
7+
'@tanstack/react-query': '@tanstack/solid-query',
8+
'useMutationState[(]': 'useMutationState(() => ',
9+
'useMutation[(]': 'useMutation(() => ',
10+
'useQuery[(]': 'useQuery(() => ',
11+
'useQueries[(]': 'useQueries(() => ',
12+
'useInfiniteQuery[(]': 'useInfiniteQuery(() => ',
13+
}
14+
---

‎docs/framework/solid/guides/dependent-queries.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: dependent-queries
3+
title: Dependent Queries
4+
ref: docs/framework/react/guides/dependent-queries.md
5+
replace:
6+
{
7+
'@tanstack/react-query': '@tanstack/solid-query',
8+
'useMutationState[(]': 'useMutationState(() => ',
9+
'useMutation[(]': 'useMutation(() => ',
10+
'useQuery[(]': 'useQuery(() => ',
11+
'useQueries[(]': 'useQueries(() => ',
12+
'useInfiniteQuery[(]': 'useInfiniteQuery(() => ',
13+
}
14+
---

‎docs/framework/solid/guides/disabling-queries.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: disabling-queries
3+
title: Disabling/Pausing Queries
4+
ref: docs/framework/react/guides/disabling-queries.md
5+
replace:
6+
{
7+
'@tanstack/react-query': '@tanstack/solid-query',
8+
'useMutationState[(]': 'useMutationState(() => ',
9+
'useMutation[(]': 'useMutation(() => ',
10+
'useQuery[(]': 'useQuery(() => ',
11+
'useQueries[(]': 'useQueries(() => ',
12+
'useInfiniteQuery[(]': 'useInfiniteQuery(() => ',
13+
}
14+
---

‎docs/framework/solid/guides/does-this-replace-client-state.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
id: does-this-replace-client-state
3+
title: Does TanStack Query replace global state managers?
4+
ref: docs/framework/react/guides/does-this-replace-client-state.md
5+
replace: { 'hook': 'function' }
6+
---

0 commit comments

Comments
 (0)