@tanstack/preact-query 5.102.4 → 5.102.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/build/legacy/QueryErrorResetBoundary.cjs +11 -9
  2. package/build/legacy/QueryErrorResetBoundary.cjs.map +1 -1
  3. package/build/legacy/QueryErrorResetBoundary.d.cts +11 -9
  4. package/build/legacy/QueryErrorResetBoundary.d.cts.map +1 -1
  5. package/build/legacy/QueryErrorResetBoundary.d.ts +11 -9
  6. package/build/legacy/QueryErrorResetBoundary.d.ts.map +1 -1
  7. package/build/legacy/QueryErrorResetBoundary.js +11 -9
  8. package/build/legacy/QueryErrorResetBoundary.js.map +1 -1
  9. package/build/legacy/useInfiniteQuery.cjs.map +1 -1
  10. package/build/legacy/useInfiniteQuery.d.cts +28 -24
  11. package/build/legacy/useInfiniteQuery.d.cts.map +1 -1
  12. package/build/legacy/useInfiniteQuery.d.ts +28 -24
  13. package/build/legacy/useInfiniteQuery.d.ts.map +1 -1
  14. package/build/legacy/useInfiniteQuery.js.map +1 -1
  15. package/build/legacy/useIsFetching.cjs +14 -0
  16. package/build/legacy/useIsFetching.cjs.map +1 -1
  17. package/build/legacy/useIsFetching.d.cts +14 -0
  18. package/build/legacy/useIsFetching.d.cts.map +1 -1
  19. package/build/legacy/useIsFetching.d.ts +14 -0
  20. package/build/legacy/useIsFetching.d.ts.map +1 -1
  21. package/build/legacy/useIsFetching.js +14 -0
  22. package/build/legacy/useIsFetching.js.map +1 -1
  23. package/build/legacy/useMutation.cjs +104 -1
  24. package/build/legacy/useMutation.cjs.map +1 -1
  25. package/build/legacy/useMutation.d.cts +104 -1
  26. package/build/legacy/useMutation.d.cts.map +1 -1
  27. package/build/legacy/useMutation.d.ts +104 -1
  28. package/build/legacy/useMutation.d.ts.map +1 -1
  29. package/build/legacy/useMutation.js +104 -1
  30. package/build/legacy/useMutation.js.map +1 -1
  31. package/build/legacy/useQuery.cjs.map +1 -1
  32. package/build/legacy/useQuery.d.cts +54 -2
  33. package/build/legacy/useQuery.d.cts.map +1 -1
  34. package/build/legacy/useQuery.d.ts +54 -2
  35. package/build/legacy/useQuery.d.ts.map +1 -1
  36. package/build/legacy/useQuery.js.map +1 -1
  37. package/build/legacy/useSuspenseInfiniteQuery.cjs +16 -8
  38. package/build/legacy/useSuspenseInfiniteQuery.cjs.map +1 -1
  39. package/build/legacy/useSuspenseInfiniteQuery.d.cts +16 -8
  40. package/build/legacy/useSuspenseInfiniteQuery.d.cts.map +1 -1
  41. package/build/legacy/useSuspenseInfiniteQuery.d.ts +16 -8
  42. package/build/legacy/useSuspenseInfiniteQuery.d.ts.map +1 -1
  43. package/build/legacy/useSuspenseInfiniteQuery.js +16 -8
  44. package/build/legacy/useSuspenseInfiniteQuery.js.map +1 -1
  45. package/build/legacy/useSuspenseQueries.cjs.map +1 -1
  46. package/build/legacy/useSuspenseQueries.d.cts +74 -6
  47. package/build/legacy/useSuspenseQueries.d.cts.map +1 -1
  48. package/build/legacy/useSuspenseQueries.d.ts +74 -6
  49. package/build/legacy/useSuspenseQueries.d.ts.map +1 -1
  50. package/build/legacy/useSuspenseQueries.js.map +1 -1
  51. package/build/legacy/useSuspenseQuery.cjs +4 -0
  52. package/build/legacy/useSuspenseQuery.cjs.map +1 -1
  53. package/build/legacy/useSuspenseQuery.d.cts +4 -0
  54. package/build/legacy/useSuspenseQuery.d.cts.map +1 -1
  55. package/build/legacy/useSuspenseQuery.d.ts +4 -0
  56. package/build/legacy/useSuspenseQuery.d.ts.map +1 -1
  57. package/build/legacy/useSuspenseQuery.js +4 -0
  58. package/build/legacy/useSuspenseQuery.js.map +1 -1
  59. package/build/modern/QueryErrorResetBoundary.cjs +11 -9
  60. package/build/modern/QueryErrorResetBoundary.cjs.map +1 -1
  61. package/build/modern/QueryErrorResetBoundary.d.cts +11 -9
  62. package/build/modern/QueryErrorResetBoundary.d.cts.map +1 -1
  63. package/build/modern/QueryErrorResetBoundary.d.ts +11 -9
  64. package/build/modern/QueryErrorResetBoundary.d.ts.map +1 -1
  65. package/build/modern/QueryErrorResetBoundary.js +11 -9
  66. package/build/modern/QueryErrorResetBoundary.js.map +1 -1
  67. package/build/modern/useInfiniteQuery.cjs.map +1 -1
  68. package/build/modern/useInfiniteQuery.d.cts +28 -24
  69. package/build/modern/useInfiniteQuery.d.cts.map +1 -1
  70. package/build/modern/useInfiniteQuery.d.ts +28 -24
  71. package/build/modern/useInfiniteQuery.d.ts.map +1 -1
  72. package/build/modern/useInfiniteQuery.js.map +1 -1
  73. package/build/modern/useIsFetching.cjs +14 -0
  74. package/build/modern/useIsFetching.cjs.map +1 -1
  75. package/build/modern/useIsFetching.d.cts +14 -0
  76. package/build/modern/useIsFetching.d.cts.map +1 -1
  77. package/build/modern/useIsFetching.d.ts +14 -0
  78. package/build/modern/useIsFetching.d.ts.map +1 -1
  79. package/build/modern/useIsFetching.js +14 -0
  80. package/build/modern/useIsFetching.js.map +1 -1
  81. package/build/modern/useMutation.cjs +104 -1
  82. package/build/modern/useMutation.cjs.map +1 -1
  83. package/build/modern/useMutation.d.cts +104 -1
  84. package/build/modern/useMutation.d.cts.map +1 -1
  85. package/build/modern/useMutation.d.ts +104 -1
  86. package/build/modern/useMutation.d.ts.map +1 -1
  87. package/build/modern/useMutation.js +104 -1
  88. package/build/modern/useMutation.js.map +1 -1
  89. package/build/modern/useQuery.cjs.map +1 -1
  90. package/build/modern/useQuery.d.cts +54 -2
  91. package/build/modern/useQuery.d.cts.map +1 -1
  92. package/build/modern/useQuery.d.ts +54 -2
  93. package/build/modern/useQuery.d.ts.map +1 -1
  94. package/build/modern/useQuery.js.map +1 -1
  95. package/build/modern/useSuspenseInfiniteQuery.cjs +16 -8
  96. package/build/modern/useSuspenseInfiniteQuery.cjs.map +1 -1
  97. package/build/modern/useSuspenseInfiniteQuery.d.cts +16 -8
  98. package/build/modern/useSuspenseInfiniteQuery.d.cts.map +1 -1
  99. package/build/modern/useSuspenseInfiniteQuery.d.ts +16 -8
  100. package/build/modern/useSuspenseInfiniteQuery.d.ts.map +1 -1
  101. package/build/modern/useSuspenseInfiniteQuery.js +16 -8
  102. package/build/modern/useSuspenseInfiniteQuery.js.map +1 -1
  103. package/build/modern/useSuspenseQueries.cjs.map +1 -1
  104. package/build/modern/useSuspenseQueries.d.cts +74 -6
  105. package/build/modern/useSuspenseQueries.d.cts.map +1 -1
  106. package/build/modern/useSuspenseQueries.d.ts +74 -6
  107. package/build/modern/useSuspenseQueries.d.ts.map +1 -1
  108. package/build/modern/useSuspenseQueries.js.map +1 -1
  109. package/build/modern/useSuspenseQuery.cjs +4 -0
  110. package/build/modern/useSuspenseQuery.cjs.map +1 -1
  111. package/build/modern/useSuspenseQuery.d.cts +4 -0
  112. package/build/modern/useSuspenseQuery.d.cts.map +1 -1
  113. package/build/modern/useSuspenseQuery.d.ts +4 -0
  114. package/build/modern/useSuspenseQuery.d.ts.map +1 -1
  115. package/build/modern/useSuspenseQuery.js +4 -0
  116. package/build/modern/useSuspenseQuery.js.map +1 -1
  117. package/package.json +3 -3
  118. package/src/QueryErrorResetBoundary.tsx +11 -9
  119. package/src/useInfiniteQuery.ts +28 -24
  120. package/src/useIsFetching.ts +14 -0
  121. package/src/useMutation.ts +104 -1
  122. package/src/useQuery.ts +54 -2
  123. package/src/useSuspenseInfiniteQuery.ts +16 -8
  124. package/src/useSuspenseQueries.ts +74 -6
  125. package/src/useSuspenseQuery.ts +4 -0
@@ -54,25 +54,27 @@ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = I
54
54
  *
55
55
  * @example
56
56
  * ```tsx
57
- * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'
58
- *
59
- * const projectsOptions = infiniteQueryOptions({
60
- * queryKey: ['projects'],
61
- * queryFn: ({ pageParam }) => fetchProjects(pageParam),
62
- * initialPageParam: 0,
63
- * getNextPageParam: (lastPage) => lastPage.nextId,
64
- * })
57
+ * import { useInfiniteQuery } from '@tanstack/preact-query'
65
58
  *
66
59
  * function Projects() {
67
- * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =
68
- * useInfiniteQuery(projectsOptions)
60
+ * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =
61
+ * useInfiniteQuery({
62
+ * queryKey: ['projects'],
63
+ * queryFn: ({ pageParam }) => fetchProjects(pageParam),
64
+ * initialPageParam: 0,
65
+ * getNextPageParam: (lastPage) => lastPage.nextId,
66
+ * })
69
67
  *
70
68
  * return (
71
69
  * <button
72
70
  * onClick={() => fetchNextPage()}
73
- * disabled={!hasNextPage || isFetchingNextPage}
71
+ * disabled={!hasNextPage || isFetching}
74
72
  * >
75
- * Load More
73
+ * {isFetchingNextPage
74
+ * ? 'Loading more...'
75
+ * : hasNextPage
76
+ * ? 'Load More'
77
+ * : 'Nothing more to load'}
76
78
  * </button>
77
79
  * )
78
80
  * }
@@ -96,25 +98,27 @@ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = I
96
98
  *
97
99
  * @example
98
100
  * ```tsx
99
- * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'
100
- *
101
- * const projectsOptions = infiniteQueryOptions({
102
- * queryKey: ['projects'],
103
- * queryFn: ({ pageParam }) => fetchProjects(pageParam),
104
- * initialPageParam: 0,
105
- * getNextPageParam: (lastPage) => lastPage.nextId,
106
- * })
101
+ * import { useInfiniteQuery } from '@tanstack/preact-query'
107
102
  *
108
103
  * function Projects() {
109
- * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =
110
- * useInfiniteQuery(projectsOptions)
104
+ * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =
105
+ * useInfiniteQuery({
106
+ * queryKey: ['projects'],
107
+ * queryFn: ({ pageParam }) => fetchProjects(pageParam),
108
+ * initialPageParam: 0,
109
+ * getNextPageParam: (lastPage) => lastPage.nextId,
110
+ * })
111
111
  *
112
112
  * return (
113
113
  * <button
114
114
  * onClick={() => fetchNextPage()}
115
- * disabled={!hasNextPage || isFetchingNextPage}
115
+ * disabled={!hasNextPage || isFetching}
116
116
  * >
117
- * Load More
117
+ * {isFetchingNextPage
118
+ * ? 'Loading more...'
119
+ * : hasNextPage
120
+ * ? 'Load More'
121
+ * : 'Nothing more to load'}
118
122
  * </button>
119
123
  * )
120
124
  * }
@@ -1 +1 @@
1
- {"version":3,"file":"useInfiniteQuery.d.cts","names":[],"sources":["../../src/useInfiniteQuery.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsDgB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,kCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,8BAA8B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CxB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,oCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CjB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,wBACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO"}
1
+ {"version":3,"file":"useInfiniteQuery.d.cts","names":[],"sources":["../../src/useInfiniteQuery.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsDgB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,kCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,8BAA8B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6CxB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,oCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6CjB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,wBACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO"}
@@ -54,25 +54,27 @@ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = I
54
54
  *
55
55
  * @example
56
56
  * ```tsx
57
- * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'
58
- *
59
- * const projectsOptions = infiniteQueryOptions({
60
- * queryKey: ['projects'],
61
- * queryFn: ({ pageParam }) => fetchProjects(pageParam),
62
- * initialPageParam: 0,
63
- * getNextPageParam: (lastPage) => lastPage.nextId,
64
- * })
57
+ * import { useInfiniteQuery } from '@tanstack/preact-query'
65
58
  *
66
59
  * function Projects() {
67
- * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =
68
- * useInfiniteQuery(projectsOptions)
60
+ * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =
61
+ * useInfiniteQuery({
62
+ * queryKey: ['projects'],
63
+ * queryFn: ({ pageParam }) => fetchProjects(pageParam),
64
+ * initialPageParam: 0,
65
+ * getNextPageParam: (lastPage) => lastPage.nextId,
66
+ * })
69
67
  *
70
68
  * return (
71
69
  * <button
72
70
  * onClick={() => fetchNextPage()}
73
- * disabled={!hasNextPage || isFetchingNextPage}
71
+ * disabled={!hasNextPage || isFetching}
74
72
  * >
75
- * Load More
73
+ * {isFetchingNextPage
74
+ * ? 'Loading more...'
75
+ * : hasNextPage
76
+ * ? 'Load More'
77
+ * : 'Nothing more to load'}
76
78
  * </button>
77
79
  * )
78
80
  * }
@@ -96,25 +98,27 @@ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = I
96
98
  *
97
99
  * @example
98
100
  * ```tsx
99
- * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'
100
- *
101
- * const projectsOptions = infiniteQueryOptions({
102
- * queryKey: ['projects'],
103
- * queryFn: ({ pageParam }) => fetchProjects(pageParam),
104
- * initialPageParam: 0,
105
- * getNextPageParam: (lastPage) => lastPage.nextId,
106
- * })
101
+ * import { useInfiniteQuery } from '@tanstack/preact-query'
107
102
  *
108
103
  * function Projects() {
109
- * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =
110
- * useInfiniteQuery(projectsOptions)
104
+ * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =
105
+ * useInfiniteQuery({
106
+ * queryKey: ['projects'],
107
+ * queryFn: ({ pageParam }) => fetchProjects(pageParam),
108
+ * initialPageParam: 0,
109
+ * getNextPageParam: (lastPage) => lastPage.nextId,
110
+ * })
111
111
  *
112
112
  * return (
113
113
  * <button
114
114
  * onClick={() => fetchNextPage()}
115
- * disabled={!hasNextPage || isFetchingNextPage}
115
+ * disabled={!hasNextPage || isFetching}
116
116
  * >
117
- * Load More
117
+ * {isFetchingNextPage
118
+ * ? 'Loading more...'
119
+ * : hasNextPage
120
+ * ? 'Load More'
121
+ * : 'Nothing more to load'}
118
122
  * </button>
119
123
  * )
120
124
  * }
@@ -1 +1 @@
1
- {"version":3,"file":"useInfiniteQuery.d.ts","names":[],"sources":["../../src/useInfiniteQuery.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsDgB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,kCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,8BAA8B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CxB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,oCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CjB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,wBACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO"}
1
+ {"version":3,"file":"useInfiniteQuery.d.ts","names":[],"sources":["../../src/useInfiniteQuery.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsDgB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,kCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,8BAA8B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6CxB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,oCACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6CjB,iBACd,cACA,SAAS,cACT,QAAQ,aAAa,eACrB,kBAAkB,WAAW,UAC7B,sBAEA,SAAS,wBACP,cACA,QACA,OACA,WACA,aAEF,cAAc,cACb,uBAAuB,OAAO"}
@@ -1 +1 @@
1
- {"version":3,"file":"useInfiniteQuery.js","names":[],"sources":["../../src/useInfiniteQuery.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport type {\n DefaultError,\n InfiniteData,\n QueryClient,\n QueryKey,\n QueryObserver,\n} from '@tanstack/query-core'\n\nimport type {\n DefinedInitialDataInfiniteOptions,\n UndefinedInitialDataInfiniteOptions,\n} from './infiniteQueryOptions'\nimport type {\n DefinedUseInfiniteQueryResult,\n UseInfiniteQueryOptions,\n UseInfiniteQueryResult,\n} from './types'\nimport { useBaseQuery } from './useBaseQuery'\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * This overload is selected when `initialData` is set.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link DefinedInitialDataInfiniteOptions} to use — everything you can pass to `useInfiniteQuery`, with `initialData` set.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { useInfiniteQuery } from '@tanstack/preact-query'\n *\n * function Projects() {\n * const { data } = useInfiniteQuery({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * initialData: { pages: [], pageParams: [] },\n * })\n *\n * return <>{data.pages.map((page) => page.projects.map((p) => <p key={p.id}>{p.name}</p>))}</>\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: DefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): DefinedUseInfiniteQueryResult<TData, TError>\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link UndefinedInitialDataInfiniteOptions} to use — everything you can pass to `useInfiniteQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'\n *\n * const projectsOptions = infiniteQueryOptions({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * })\n *\n * function Projects() {\n * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =\n * useInfiniteQuery(projectsOptions)\n *\n * return (\n * <button\n * onClick={() => fetchNextPage()}\n * disabled={!hasNextPage || isFetchingNextPage}\n * >\n * Load More\n * </button>\n * )\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: UndefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): UseInfiniteQueryResult<TData, TError>\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link UseInfiniteQueryOptions} to use — everything you can pass to `useInfiniteQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/preact-query'\n *\n * const projectsOptions = infiniteQueryOptions({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * })\n *\n * function Projects() {\n * const { data, fetchNextPage, hasNextPage, isFetchingNextPage } =\n * useInfiniteQuery(projectsOptions)\n *\n * return (\n * <button\n * onClick={() => fetchNextPage()}\n * disabled={!hasNextPage || isFetchingNextPage}\n * >\n * Load More\n * </button>\n * )\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: UseInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): UseInfiniteQueryResult<TData, TError>\n\nexport function useInfiniteQuery(\n options: UseInfiniteQueryOptions,\n queryClient?: QueryClient,\n) {\n return useBaseQuery(\n options,\n InfiniteQueryObserver as typeof QueryObserver,\n queryClient,\n )\n}\n"],"mappings":";;;AA2LA,SAAgB,iBACd,SACA,aACA;CACA,OAAO,aACL,SACA,uBACA,WACF;AACF"}
1
+ {"version":3,"file":"useInfiniteQuery.js","names":[],"sources":["../../src/useInfiniteQuery.ts"],"sourcesContent":["import { InfiniteQueryObserver } from '@tanstack/query-core'\nimport type {\n DefaultError,\n InfiniteData,\n QueryClient,\n QueryKey,\n QueryObserver,\n} from '@tanstack/query-core'\n\nimport type {\n DefinedInitialDataInfiniteOptions,\n UndefinedInitialDataInfiniteOptions,\n} from './infiniteQueryOptions'\nimport type {\n DefinedUseInfiniteQueryResult,\n UseInfiniteQueryOptions,\n UseInfiniteQueryResult,\n} from './types'\nimport { useBaseQuery } from './useBaseQuery'\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * This overload is selected when `initialData` is set.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link DefinedInitialDataInfiniteOptions} to use — everything you can pass to `useInfiniteQuery`, with `initialData` set.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { useInfiniteQuery } from '@tanstack/preact-query'\n *\n * function Projects() {\n * const { data } = useInfiniteQuery({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * initialData: { pages: [], pageParams: [] },\n * })\n *\n * return <>{data.pages.map((page) => page.projects.map((p) => <p key={p.id}>{p.name}</p>))}</>\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: DefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): DefinedUseInfiniteQueryResult<TData, TError>\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link UndefinedInitialDataInfiniteOptions} to use — everything you can pass to `useInfiniteQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { useInfiniteQuery } from '@tanstack/preact-query'\n *\n * function Projects() {\n * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =\n * useInfiniteQuery({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * })\n *\n * return (\n * <button\n * onClick={() => fetchNextPage()}\n * disabled={!hasNextPage || isFetching}\n * >\n * {isFetchingNextPage\n * ? 'Loading more...'\n * : hasNextPage\n * ? 'Load More'\n * : 'Nothing more to load'}\n * </button>\n * )\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: UndefinedInitialDataInfiniteOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): UseInfiniteQueryResult<TData, TError>\n\n/**\n * The options for `useInfiniteQuery` are identical to `useQuery`, with the addition of `queryFn`,\n * `initialPageParam`, `getNextPageParam`, `getPreviousPageParam`, and `maxPages`.\n *\n * @remarks Keep in mind that imperative fetch calls, such as `fetchNextPage`, may interfere with the default\n * refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user\n * actions, or add conditions like `hasNextPage && !isFetching`.\n * @see {@link infiniteQueryOptions} to share these options between `useInfiniteQuery` and imperative APIs like `queryClient.infiniteQuery`.\n * @param options - The {@link UseInfiniteQueryOptions} to use — everything you can pass to `useInfiniteQuery`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns The same properties as `useQuery`, with the addition of `data.pages`, `data.pageParams`,\n * `fetchNextPage`, `fetchPreviousPage`, `hasNextPage`, `hasPreviousPage`, `isFetchingNextPage`, and\n * `isFetchingPreviousPage`.\n *\n * @example\n * ```tsx\n * import { useInfiniteQuery } from '@tanstack/preact-query'\n *\n * function Projects() {\n * const { data, fetchNextPage, hasNextPage, isFetching, isFetchingNextPage } =\n * useInfiniteQuery({\n * queryKey: ['projects'],\n * queryFn: ({ pageParam }) => fetchProjects(pageParam),\n * initialPageParam: 0,\n * getNextPageParam: (lastPage) => lastPage.nextId,\n * })\n *\n * return (\n * <button\n * onClick={() => fetchNextPage()}\n * disabled={!hasNextPage || isFetching}\n * >\n * {isFetchingNextPage\n * ? 'Loading more...'\n * : hasNextPage\n * ? 'Load More'\n * : 'Nothing more to load'}\n * </button>\n * )\n * }\n * ```\n */\nexport function useInfiniteQuery<\n TQueryFnData,\n TError = DefaultError,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n TPageParam = unknown,\n>(\n options: UseInfiniteQueryOptions<\n TQueryFnData,\n TError,\n TData,\n TQueryKey,\n TPageParam\n >,\n queryClient?: QueryClient,\n): UseInfiniteQueryResult<TData, TError>\n\nexport function useInfiniteQuery(\n options: UseInfiniteQueryOptions,\n queryClient?: QueryClient,\n) {\n return useBaseQuery(\n options,\n InfiniteQueryObserver as typeof QueryObserver,\n queryClient,\n )\n}\n"],"mappings":";;;AA+LA,SAAgB,iBACd,SACA,aACA;CACA,OAAO,aACL,SACA,uBACA,WACF;AACF"}
@@ -23,6 +23,20 @@ let preact_hooks = require("preact/hooks");
23
23
  * // How many queries matching the posts prefix are fetching?
24
24
  * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })
25
25
  * ```
26
+ *
27
+ * @example
28
+ * A global loading indicator for any query fetching in the background, not just the ones on screen:
29
+ * ```tsx
30
+ * import { useIsFetching } from '@tanstack/preact-query'
31
+ *
32
+ * function GlobalLoadingIndicator() {
33
+ * const isFetching = useIsFetching()
34
+ *
35
+ * return isFetching ? (
36
+ * <div>Queries are fetching in the background...</div>
37
+ * ) : null
38
+ * }
39
+ * ```
26
40
  */
27
41
  function useIsFetching(filters, queryClient) {
28
42
  const client = require_QueryClientProvider.useQueryClient(queryClient);
@@ -1 +1 @@
1
- {"version":3,"file":"useIsFetching.cjs","names":["useQueryClient","useSyncExternalStore","useCallback","notifyManager"],"sources":["../../src/useIsFetching.ts"],"sourcesContent":["import { notifyManager } from '@tanstack/query-core'\nimport type { QueryClient, QueryFilters } from '@tanstack/query-core'\nimport { useCallback } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport { useSyncExternalStore } from './utils'\n\n/**\n * `useIsFetching` is an optional hook that returns the `number` of the queries that your application is loading or\n * fetching in the background (useful for app-wide loading indicators).\n *\n * @param filters - The {@link QueryFilters} to narrow down the matched queries.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns Will be the `number` of the queries that your application is currently loading or fetching in the\n * background.\n *\n * @example\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * // How many queries are fetching?\n * const isFetching = useIsFetching()\n * // How many queries matching the posts prefix are fetching?\n * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })\n * ```\n */\nexport function useIsFetching(\n filters?: QueryFilters,\n queryClient?: QueryClient,\n): number {\n const client = useQueryClient(queryClient)\n const queryCache = client.getQueryCache()\n\n return useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n queryCache.subscribe(notifyManager.batchCalls(onStoreChange)),\n [queryCache],\n ),\n () => client.isFetching(filters),\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,cACd,SACA,aACQ;CACR,MAAM,SAASA,4BAAAA,eAAe,WAAW;CACzC,MAAM,aAAa,OAAO,cAAc;CAExC,OAAOC,cAAAA,sBAAAA,GACLC,aAAAA,YAAAA,EACG,kBACC,WAAW,UAAUC,qBAAAA,cAAc,WAAW,aAAa,CAAC,GAC9D,CAAC,UAAU,CACb,SACM,OAAO,WAAW,OAAO,CACjC;AACF"}
1
+ {"version":3,"file":"useIsFetching.cjs","names":["useQueryClient","useSyncExternalStore","useCallback","notifyManager"],"sources":["../../src/useIsFetching.ts"],"sourcesContent":["import { notifyManager } from '@tanstack/query-core'\nimport type { QueryClient, QueryFilters } from '@tanstack/query-core'\nimport { useCallback } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport { useSyncExternalStore } from './utils'\n\n/**\n * `useIsFetching` is an optional hook that returns the `number` of the queries that your application is loading or\n * fetching in the background (useful for app-wide loading indicators).\n *\n * @param filters - The {@link QueryFilters} to narrow down the matched queries.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns Will be the `number` of the queries that your application is currently loading or fetching in the\n * background.\n *\n * @example\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * // How many queries are fetching?\n * const isFetching = useIsFetching()\n * // How many queries matching the posts prefix are fetching?\n * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })\n * ```\n *\n * @example\n * A global loading indicator for any query fetching in the background, not just the ones on screen:\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * function GlobalLoadingIndicator() {\n * const isFetching = useIsFetching()\n *\n * return isFetching ? (\n * <div>Queries are fetching in the background...</div>\n * ) : null\n * }\n * ```\n */\nexport function useIsFetching(\n filters?: QueryFilters,\n queryClient?: QueryClient,\n): number {\n const client = useQueryClient(queryClient)\n const queryCache = client.getQueryCache()\n\n return useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n queryCache.subscribe(notifyManager.batchCalls(onStoreChange)),\n [queryCache],\n ),\n () => client.isFetching(filters),\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,cACd,SACA,aACQ;CACR,MAAM,SAASA,4BAAAA,eAAe,WAAW;CACzC,MAAM,aAAa,OAAO,cAAc;CAExC,OAAOC,cAAAA,sBAAAA,GACLC,aAAAA,YAAAA,EACG,kBACC,WAAW,UAAUC,qBAAAA,cAAc,WAAW,aAAa,CAAC,GAC9D,CAAC,UAAU,CACb,SACM,OAAO,WAAW,OAAO,CACjC;AACF"}
@@ -19,6 +19,20 @@ import { QueryClient, QueryFilters } from "@tanstack/query-core";
19
19
  * // How many queries matching the posts prefix are fetching?
20
20
  * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })
21
21
  * ```
22
+ *
23
+ * @example
24
+ * A global loading indicator for any query fetching in the background, not just the ones on screen:
25
+ * ```tsx
26
+ * import { useIsFetching } from '@tanstack/preact-query'
27
+ *
28
+ * function GlobalLoadingIndicator() {
29
+ * const isFetching = useIsFetching()
30
+ *
31
+ * return isFetching ? (
32
+ * <div>Queries are fetching in the background...</div>
33
+ * ) : null
34
+ * }
35
+ * ```
22
36
  */
23
37
  declare function useIsFetching(filters?: QueryFilters, queryClient?: QueryClient): number;
24
38
  //#endregion
@@ -1 +1 @@
1
- {"version":3,"file":"useIsFetching.d.cts","names":[],"sources":["../../src/useIsFetching.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;iBA2BgB,cACd,UAAU,cACV,cAAc"}
1
+ {"version":3,"file":"useIsFetching.d.cts","names":[],"sources":["../../src/useIsFetching.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyCgB,cACd,UAAU,cACV,cAAc"}
@@ -19,6 +19,20 @@ import { QueryClient, QueryFilters } from "@tanstack/query-core";
19
19
  * // How many queries matching the posts prefix are fetching?
20
20
  * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })
21
21
  * ```
22
+ *
23
+ * @example
24
+ * A global loading indicator for any query fetching in the background, not just the ones on screen:
25
+ * ```tsx
26
+ * import { useIsFetching } from '@tanstack/preact-query'
27
+ *
28
+ * function GlobalLoadingIndicator() {
29
+ * const isFetching = useIsFetching()
30
+ *
31
+ * return isFetching ? (
32
+ * <div>Queries are fetching in the background...</div>
33
+ * ) : null
34
+ * }
35
+ * ```
22
36
  */
23
37
  declare function useIsFetching(filters?: QueryFilters, queryClient?: QueryClient): number;
24
38
  //#endregion
@@ -1 +1 @@
1
- {"version":3,"file":"useIsFetching.d.ts","names":[],"sources":["../../src/useIsFetching.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;iBA2BgB,cACd,UAAU,cACV,cAAc"}
1
+ {"version":3,"file":"useIsFetching.d.ts","names":[],"sources":["../../src/useIsFetching.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyCgB,cACd,UAAU,cACV,cAAc"}
@@ -22,6 +22,20 @@ import { useCallback } from "preact/hooks";
22
22
  * // How many queries matching the posts prefix are fetching?
23
23
  * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })
24
24
  * ```
25
+ *
26
+ * @example
27
+ * A global loading indicator for any query fetching in the background, not just the ones on screen:
28
+ * ```tsx
29
+ * import { useIsFetching } from '@tanstack/preact-query'
30
+ *
31
+ * function GlobalLoadingIndicator() {
32
+ * const isFetching = useIsFetching()
33
+ *
34
+ * return isFetching ? (
35
+ * <div>Queries are fetching in the background...</div>
36
+ * ) : null
37
+ * }
38
+ * ```
25
39
  */
26
40
  function useIsFetching(filters, queryClient) {
27
41
  const client = useQueryClient(queryClient);
@@ -1 +1 @@
1
- {"version":3,"file":"useIsFetching.js","names":[],"sources":["../../src/useIsFetching.ts"],"sourcesContent":["import { notifyManager } from '@tanstack/query-core'\nimport type { QueryClient, QueryFilters } from '@tanstack/query-core'\nimport { useCallback } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport { useSyncExternalStore } from './utils'\n\n/**\n * `useIsFetching` is an optional hook that returns the `number` of the queries that your application is loading or\n * fetching in the background (useful for app-wide loading indicators).\n *\n * @param filters - The {@link QueryFilters} to narrow down the matched queries.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns Will be the `number` of the queries that your application is currently loading or fetching in the\n * background.\n *\n * @example\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * // How many queries are fetching?\n * const isFetching = useIsFetching()\n * // How many queries matching the posts prefix are fetching?\n * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })\n * ```\n */\nexport function useIsFetching(\n filters?: QueryFilters,\n queryClient?: QueryClient,\n): number {\n const client = useQueryClient(queryClient)\n const queryCache = client.getQueryCache()\n\n return useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n queryCache.subscribe(notifyManager.batchCalls(onStoreChange)),\n [queryCache],\n ),\n () => client.isFetching(filters),\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,cACd,SACA,aACQ;CACR,MAAM,SAAS,eAAe,WAAW;CACzC,MAAM,aAAa,OAAO,cAAc;CAExC,OAAO,qBACL,aACG,kBACC,WAAW,UAAU,cAAc,WAAW,aAAa,CAAC,GAC9D,CAAC,UAAU,CACb,SACM,OAAO,WAAW,OAAO,CACjC;AACF"}
1
+ {"version":3,"file":"useIsFetching.js","names":[],"sources":["../../src/useIsFetching.ts"],"sourcesContent":["import { notifyManager } from '@tanstack/query-core'\nimport type { QueryClient, QueryFilters } from '@tanstack/query-core'\nimport { useCallback } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport { useSyncExternalStore } from './utils'\n\n/**\n * `useIsFetching` is an optional hook that returns the `number` of the queries that your application is loading or\n * fetching in the background (useful for app-wide loading indicators).\n *\n * @param filters - The {@link QueryFilters} to narrow down the matched queries.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns Will be the `number` of the queries that your application is currently loading or fetching in the\n * background.\n *\n * @example\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * // How many queries are fetching?\n * const isFetching = useIsFetching()\n * // How many queries matching the posts prefix are fetching?\n * const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })\n * ```\n *\n * @example\n * A global loading indicator for any query fetching in the background, not just the ones on screen:\n * ```tsx\n * import { useIsFetching } from '@tanstack/preact-query'\n *\n * function GlobalLoadingIndicator() {\n * const isFetching = useIsFetching()\n *\n * return isFetching ? (\n * <div>Queries are fetching in the background...</div>\n * ) : null\n * }\n * ```\n */\nexport function useIsFetching(\n filters?: QueryFilters,\n queryClient?: QueryClient,\n): number {\n const client = useQueryClient(queryClient)\n const queryCache = client.getQueryCache()\n\n return useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n queryCache.subscribe(notifyManager.batchCalls(onStoreChange)),\n [queryCache],\n ),\n () => client.isFetching(filters),\n )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,cACd,SACA,aACQ;CACR,MAAM,SAAS,eAAe,WAAW;CACzC,MAAM,aAAa,OAAO,cAAc;CAExC,OAAO,qBACL,aACG,kBACC,WAAW,UAAU,cAAc,WAAW,aAAa,CAAC,GAC9D,CAAC,UAAU,CACb,SACM,OAAO,WAAW,OAAO,CACjC;AACF"}
@@ -30,7 +30,45 @@ let preact_hooks = require("preact/hooks");
30
30
  * })
31
31
  *
32
32
  * return (
33
- * <button onClick={() => addMutation.mutate('Item')}>Add</button>
33
+ * <button
34
+ * onClick={() =>
35
+ * addMutation.mutate('Item', {
36
+ * onError: (error) => console.error('Failed to add item:', error),
37
+ * })
38
+ * }
39
+ * >
40
+ * Add
41
+ * </button>
42
+ * )
43
+ * }
44
+ * ```
45
+ *
46
+ * @example
47
+ * Rendering the mutation's own state, rather than just firing it off:
48
+ * ```tsx
49
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
50
+ *
51
+ * function AddTodo() {
52
+ * const queryClient = useQueryClient()
53
+ *
54
+ * const addMutation = useMutation({
55
+ * mutationFn: addTodo,
56
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
57
+ * })
58
+ *
59
+ * return (
60
+ * <div>
61
+ * {addMutation.isPending ? (
62
+ * 'Adding todo...'
63
+ * ) : (
64
+ * <>
65
+ * {addMutation.isError ? (
66
+ * <div>An error occurred: {addMutation.error.message}</div>
67
+ * ) : null}
68
+ * <button onClick={() => addMutation.mutate('Item')}>Add</button>
69
+ * </>
70
+ * )}
71
+ * </div>
34
72
  * )
35
73
  * }
36
74
  * ```
@@ -70,6 +108,71 @@ let preact_hooks = require("preact/hooks");
70
108
  * )
71
109
  * }
72
110
  * ```
111
+ *
112
+ * @example
113
+ * Callbacks passed per call to `mutate` only fire for the last call — `mutateAsync` gives you a
114
+ * promise per call instead, so you can wait for all of them:
115
+ * ```tsx
116
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
117
+ *
118
+ * function AddTodos() {
119
+ * const queryClient = useQueryClient()
120
+ *
121
+ * const addMutation = useMutation({
122
+ * mutationFn: addTodo,
123
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
124
+ * })
125
+ *
126
+ * async function handleAddAll(todos: Array<string>) {
127
+ * try {
128
+ * await Promise.all(todos.map((todo) => addMutation.mutateAsync(todo)))
129
+ * } catch (error) {
130
+ * console.error('Failed to add todos:', error)
131
+ * }
132
+ * }
133
+ *
134
+ * return (
135
+ * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>
136
+ * Add all
137
+ * </button>
138
+ * )
139
+ * }
140
+ * ```
141
+ *
142
+ * @example
143
+ * If some of the mutations above can fail independently of the others, and you want to know which ones
144
+ * did — rather than losing that information the moment the first one rejects — swap `Promise.all` for
145
+ * `Promise.allSettled`:
146
+ * ```tsx
147
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
148
+ *
149
+ * function AddTodos() {
150
+ * const queryClient = useQueryClient()
151
+ *
152
+ * const addMutation = useMutation({
153
+ * mutationFn: addTodo,
154
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
155
+ * })
156
+ *
157
+ * async function handleAddAll(todos: Array<string>) {
158
+ * const results = await Promise.allSettled(
159
+ * todos.map((todo) => addMutation.mutateAsync(todo)),
160
+ * )
161
+ *
162
+ * results.forEach((result, index) => {
163
+ * if (result.status === 'rejected') {
164
+ * console.error(`Failed to add "${todos[index]}":`, result.reason)
165
+ * }
166
+ * })
167
+ * }
168
+ *
169
+ * return (
170
+ * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>
171
+ * Add all
172
+ * </button>
173
+ * )
174
+ * }
175
+ * ```
73
176
  */
74
177
  function useMutation(options, queryClient) {
75
178
  const client = require_QueryClientProvider.useQueryClient(queryClient);
@@ -1 +1 @@
1
- {"version":3,"file":"useMutation.cjs","names":["useQueryClient","useState","MutationObserver","useSyncExternalStore","useCallback","notifyManager","noop","shouldThrowError"],"sources":["../../src/useMutation.ts"],"sourcesContent":["import {\n MutationObserver,\n noop,\n notifyManager,\n shouldThrowError,\n} from '@tanstack/query-core'\nimport type { DefaultError, QueryClient } from '@tanstack/query-core'\nimport { useCallback, useEffect, useState } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport type {\n UseMutateFunction,\n UseMutationOptions,\n UseMutationResult,\n} from './types'\nimport { useSyncExternalStore } from './utils'\n\n// HOOK\n\n/**\n * Unlike queries, mutations are typically used to create/update/delete data or perform server side-effects.\n * `useMutation` is the hook for that.\n *\n * @see {@link mutationOptions} to share these options across multiple `useMutation` call sites.\n * @param options - The {@link UseMutationOptions} to use — everything you can pass to `useMutation`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns `mutate`/`mutateAsync` also accept per-call `onSuccess`/`onError`/`onSettled` callbacks as a second\n * argument, useful for triggering call-site side effects (e.g. navigation) without coupling them to the shared\n * mutation definition. If you make multiple requests, `onSuccess` will fire only after the latest call you've\n * made.\n *\n * @example\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodo() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),\n * })\n *\n * return (\n * <button onClick={() => addMutation.mutate('Item')}>Add</button>\n * )\n * }\n * ```\n *\n * @example\n * Optimistic update via `onMutate`, rolling back on `onError`:\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodo() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onMutate: async (newTodo) => {\n * await queryClient.cancelQueries({ queryKey: ['todos'] })\n * const previousTodos = queryClient.getQueryData<Array<string>>(['todos'])\n *\n * queryClient.setQueryData<Array<string>>(['todos'], (old) => [\n * ...(old ?? []),\n * newTodo,\n * ])\n *\n * // Passed to `onError` as `context` if the mutation fails.\n * return { previousTodos }\n * },\n * onError: (_err, _newTodo, context) => {\n * queryClient.setQueryData(['todos'], context?.previousTodos)\n * },\n * onSettled: () => {\n * queryClient.invalidateQueries({ queryKey: ['todos'] })\n * },\n * })\n *\n * return (\n * <button onClick={() => addMutation.mutate('Item')}>Add</button>\n * )\n * }\n * ```\n */\nexport function useMutation<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n>(\n options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>,\n queryClient?: QueryClient,\n): UseMutationResult<TData, TError, TVariables, TOnMutateResult> {\n const client = useQueryClient(queryClient)\n\n const [observer] = useState(\n () =>\n new MutationObserver<TData, TError, TVariables, TOnMutateResult>(\n client,\n options,\n ),\n )\n\n useEffect(() => {\n observer.setOptions(options)\n }, [observer, options])\n\n const result = useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n observer.subscribe(notifyManager.batchCalls(onStoreChange)),\n [observer],\n ),\n () => observer.getCurrentResult(),\n )\n\n const mutate = useCallback<\n UseMutateFunction<TData, TError, TVariables, TOnMutateResult>\n >(\n (\n ...args: Parameters<\n UseMutateFunction<TData, TError, TVariables, TOnMutateResult>\n >\n ) => {\n observer.mutate(args[0] as TVariables, args[1]).catch(noop)\n },\n [observer],\n )\n\n if (\n result.error &&\n shouldThrowError(observer.options.throwOnError, [result.error])\n ) {\n throw result.error\n }\n\n return { ...result, mutate, mutateAsync: result.mutate }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsFA,SAAgB,YAMd,SACA,aAC+D;CAC/D,MAAM,SAASA,4BAAAA,eAAe,WAAW;CAEzC,MAAM,CAAC,aAAA,GAAYC,aAAAA,SAAAA,OAEf,IAAIC,qBAAAA,iBACF,QACA,OACF,CACJ;CAEA,CAAA,GAAA,aAAA,UAAA,OAAgB;EACd,SAAS,WAAW,OAAO;CAC7B,GAAG,CAAC,UAAU,OAAO,CAAC;CAEtB,MAAM,SAASC,cAAAA,sBAAAA,GACbC,aAAAA,YAAAA,EACG,kBACC,SAAS,UAAUC,qBAAAA,cAAc,WAAW,aAAa,CAAC,GAC5D,CAAC,QAAQ,CACX,SACM,SAAS,iBAAiB,CAClC;CAEA,MAAM,UAAA,GAASD,aAAAA,YAAAA,EAIX,GAAG,SAGA;EACH,SAAS,OAAO,KAAK,IAAkB,KAAK,EAAE,CAAC,CAAC,MAAME,qBAAAA,IAAI;CAC5D,GACA,CAAC,QAAQ,CACX;CAEA,IACE,OAAO,UAAA,GACPC,qBAAAA,iBAAAA,CAAiB,SAAS,QAAQ,cAAc,CAAC,OAAO,KAAK,CAAC,GAE9D,MAAM,OAAO;CAGf,OAAO;EAAE,GAAG;EAAQ;EAAQ,aAAa,OAAO;CAAO;AACzD"}
1
+ {"version":3,"file":"useMutation.cjs","names":["useQueryClient","useState","MutationObserver","useSyncExternalStore","useCallback","notifyManager","noop","shouldThrowError"],"sources":["../../src/useMutation.ts"],"sourcesContent":["import {\n MutationObserver,\n noop,\n notifyManager,\n shouldThrowError,\n} from '@tanstack/query-core'\nimport type { DefaultError, QueryClient } from '@tanstack/query-core'\nimport { useCallback, useEffect, useState } from 'preact/hooks'\n\nimport { useQueryClient } from './QueryClientProvider'\nimport type {\n UseMutateFunction,\n UseMutationOptions,\n UseMutationResult,\n} from './types'\nimport { useSyncExternalStore } from './utils'\n\n// HOOK\n\n/**\n * Unlike queries, mutations are typically used to create/update/delete data or perform server side-effects.\n * `useMutation` is the hook for that.\n *\n * @see {@link mutationOptions} to share these options across multiple `useMutation` call sites.\n * @param options - The {@link UseMutationOptions} to use — everything you can pass to `useMutation`.\n * @param queryClient - Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will\n * be used.\n * @returns `mutate`/`mutateAsync` also accept per-call `onSuccess`/`onError`/`onSettled` callbacks as a second\n * argument, useful for triggering call-site side effects (e.g. navigation) without coupling them to the shared\n * mutation definition. If you make multiple requests, `onSuccess` will fire only after the latest call you've\n * made.\n *\n * @example\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodo() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),\n * })\n *\n * return (\n * <button\n * onClick={() =>\n * addMutation.mutate('Item', {\n * onError: (error) => console.error('Failed to add item:', error),\n * })\n * }\n * >\n * Add\n * </button>\n * )\n * }\n * ```\n *\n * @example\n * Rendering the mutation's own state, rather than just firing it off:\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodo() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),\n * })\n *\n * return (\n * <div>\n * {addMutation.isPending ? (\n * 'Adding todo...'\n * ) : (\n * <>\n * {addMutation.isError ? (\n * <div>An error occurred: {addMutation.error.message}</div>\n * ) : null}\n * <button onClick={() => addMutation.mutate('Item')}>Add</button>\n * </>\n * )}\n * </div>\n * )\n * }\n * ```\n *\n * @example\n * Optimistic update via `onMutate`, rolling back on `onError`:\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodo() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onMutate: async (newTodo) => {\n * await queryClient.cancelQueries({ queryKey: ['todos'] })\n * const previousTodos = queryClient.getQueryData<Array<string>>(['todos'])\n *\n * queryClient.setQueryData<Array<string>>(['todos'], (old) => [\n * ...(old ?? []),\n * newTodo,\n * ])\n *\n * // Passed to `onError` as `context` if the mutation fails.\n * return { previousTodos }\n * },\n * onError: (_err, _newTodo, context) => {\n * queryClient.setQueryData(['todos'], context?.previousTodos)\n * },\n * onSettled: () => {\n * queryClient.invalidateQueries({ queryKey: ['todos'] })\n * },\n * })\n *\n * return (\n * <button onClick={() => addMutation.mutate('Item')}>Add</button>\n * )\n * }\n * ```\n *\n * @example\n * Callbacks passed per call to `mutate` only fire for the last call — `mutateAsync` gives you a\n * promise per call instead, so you can wait for all of them:\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodos() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),\n * })\n *\n * async function handleAddAll(todos: Array<string>) {\n * try {\n * await Promise.all(todos.map((todo) => addMutation.mutateAsync(todo)))\n * } catch (error) {\n * console.error('Failed to add todos:', error)\n * }\n * }\n *\n * return (\n * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>\n * Add all\n * </button>\n * )\n * }\n * ```\n *\n * @example\n * If some of the mutations above can fail independently of the others, and you want to know which ones\n * did — rather than losing that information the moment the first one rejects — swap `Promise.all` for\n * `Promise.allSettled`:\n * ```tsx\n * import { useMutation, useQueryClient } from '@tanstack/preact-query'\n *\n * function AddTodos() {\n * const queryClient = useQueryClient()\n *\n * const addMutation = useMutation({\n * mutationFn: addTodo,\n * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),\n * })\n *\n * async function handleAddAll(todos: Array<string>) {\n * const results = await Promise.allSettled(\n * todos.map((todo) => addMutation.mutateAsync(todo)),\n * )\n *\n * results.forEach((result, index) => {\n * if (result.status === 'rejected') {\n * console.error(`Failed to add \"${todos[index]}\":`, result.reason)\n * }\n * })\n * }\n *\n * return (\n * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>\n * Add all\n * </button>\n * )\n * }\n * ```\n */\nexport function useMutation<\n TData = unknown,\n TError = DefaultError,\n TVariables = void,\n TOnMutateResult = unknown,\n>(\n options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>,\n queryClient?: QueryClient,\n): UseMutationResult<TData, TError, TVariables, TOnMutateResult> {\n const client = useQueryClient(queryClient)\n\n const [observer] = useState(\n () =>\n new MutationObserver<TData, TError, TVariables, TOnMutateResult>(\n client,\n options,\n ),\n )\n\n useEffect(() => {\n observer.setOptions(options)\n }, [observer, options])\n\n const result = useSyncExternalStore(\n useCallback(\n (onStoreChange) =>\n observer.subscribe(notifyManager.batchCalls(onStoreChange)),\n [observer],\n ),\n () => observer.getCurrentResult(),\n )\n\n const mutate = useCallback<\n UseMutateFunction<TData, TError, TVariables, TOnMutateResult>\n >(\n (\n ...args: Parameters<\n UseMutateFunction<TData, TError, TVariables, TOnMutateResult>\n >\n ) => {\n observer.mutate(args[0] as TVariables, args[1]).catch(noop)\n },\n [observer],\n )\n\n if (\n result.error &&\n shouldThrowError(observer.options.throwOnError, [result.error])\n ) {\n throw result.error\n }\n\n return { ...result, mutate, mutateAsync: result.mutate }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6LA,SAAgB,YAMd,SACA,aAC+D;CAC/D,MAAM,SAASA,4BAAAA,eAAe,WAAW;CAEzC,MAAM,CAAC,aAAA,GAAYC,aAAAA,SAAAA,OAEf,IAAIC,qBAAAA,iBACF,QACA,OACF,CACJ;CAEA,CAAA,GAAA,aAAA,UAAA,OAAgB;EACd,SAAS,WAAW,OAAO;CAC7B,GAAG,CAAC,UAAU,OAAO,CAAC;CAEtB,MAAM,SAASC,cAAAA,sBAAAA,GACbC,aAAAA,YAAAA,EACG,kBACC,SAAS,UAAUC,qBAAAA,cAAc,WAAW,aAAa,CAAC,GAC5D,CAAC,QAAQ,CACX,SACM,SAAS,iBAAiB,CAClC;CAEA,MAAM,UAAA,GAASD,aAAAA,YAAAA,EAIX,GAAG,SAGA;EACH,SAAS,OAAO,KAAK,IAAkB,KAAK,EAAE,CAAC,CAAC,MAAME,qBAAAA,IAAI;CAC5D,GACA,CAAC,QAAQ,CACX;CAEA,IACE,OAAO,UAAA,GACPC,qBAAAA,iBAAAA,CAAiB,SAAS,QAAQ,cAAc,CAAC,OAAO,KAAK,CAAC,GAE9D,MAAM,OAAO;CAGf,OAAO;EAAE,GAAG;EAAQ;EAAQ,aAAa,OAAO;CAAO;AACzD"}
@@ -27,7 +27,45 @@ import { DefaultError, QueryClient } from "@tanstack/query-core";
27
27
  * })
28
28
  *
29
29
  * return (
30
- * <button onClick={() => addMutation.mutate('Item')}>Add</button>
30
+ * <button
31
+ * onClick={() =>
32
+ * addMutation.mutate('Item', {
33
+ * onError: (error) => console.error('Failed to add item:', error),
34
+ * })
35
+ * }
36
+ * >
37
+ * Add
38
+ * </button>
39
+ * )
40
+ * }
41
+ * ```
42
+ *
43
+ * @example
44
+ * Rendering the mutation's own state, rather than just firing it off:
45
+ * ```tsx
46
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
47
+ *
48
+ * function AddTodo() {
49
+ * const queryClient = useQueryClient()
50
+ *
51
+ * const addMutation = useMutation({
52
+ * mutationFn: addTodo,
53
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
54
+ * })
55
+ *
56
+ * return (
57
+ * <div>
58
+ * {addMutation.isPending ? (
59
+ * 'Adding todo...'
60
+ * ) : (
61
+ * <>
62
+ * {addMutation.isError ? (
63
+ * <div>An error occurred: {addMutation.error.message}</div>
64
+ * ) : null}
65
+ * <button onClick={() => addMutation.mutate('Item')}>Add</button>
66
+ * </>
67
+ * )}
68
+ * </div>
31
69
  * )
32
70
  * }
33
71
  * ```
@@ -67,6 +105,71 @@ import { DefaultError, QueryClient } from "@tanstack/query-core";
67
105
  * )
68
106
  * }
69
107
  * ```
108
+ *
109
+ * @example
110
+ * Callbacks passed per call to `mutate` only fire for the last call — `mutateAsync` gives you a
111
+ * promise per call instead, so you can wait for all of them:
112
+ * ```tsx
113
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
114
+ *
115
+ * function AddTodos() {
116
+ * const queryClient = useQueryClient()
117
+ *
118
+ * const addMutation = useMutation({
119
+ * mutationFn: addTodo,
120
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
121
+ * })
122
+ *
123
+ * async function handleAddAll(todos: Array<string>) {
124
+ * try {
125
+ * await Promise.all(todos.map((todo) => addMutation.mutateAsync(todo)))
126
+ * } catch (error) {
127
+ * console.error('Failed to add todos:', error)
128
+ * }
129
+ * }
130
+ *
131
+ * return (
132
+ * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>
133
+ * Add all
134
+ * </button>
135
+ * )
136
+ * }
137
+ * ```
138
+ *
139
+ * @example
140
+ * If some of the mutations above can fail independently of the others, and you want to know which ones
141
+ * did — rather than losing that information the moment the first one rejects — swap `Promise.all` for
142
+ * `Promise.allSettled`:
143
+ * ```tsx
144
+ * import { useMutation, useQueryClient } from '@tanstack/preact-query'
145
+ *
146
+ * function AddTodos() {
147
+ * const queryClient = useQueryClient()
148
+ *
149
+ * const addMutation = useMutation({
150
+ * mutationFn: addTodo,
151
+ * onSuccess: () => queryClient.invalidateQueries({ queryKey: ['todos'] }),
152
+ * })
153
+ *
154
+ * async function handleAddAll(todos: Array<string>) {
155
+ * const results = await Promise.allSettled(
156
+ * todos.map((todo) => addMutation.mutateAsync(todo)),
157
+ * )
158
+ *
159
+ * results.forEach((result, index) => {
160
+ * if (result.status === 'rejected') {
161
+ * console.error(`Failed to add "${todos[index]}":`, result.reason)
162
+ * }
163
+ * })
164
+ * }
165
+ *
166
+ * return (
167
+ * <button onClick={() => handleAddAll(['Todo 1', 'Todo 2', 'Todo 3'])}>
168
+ * Add all
169
+ * </button>
170
+ * )
171
+ * }
172
+ * ```
70
173
  */
71
174
  declare function useMutation<TData = unknown, TError = DefaultError, TVariables = void, TOnMutateResult = unknown>(options: UseMutationOptions<TData, TError, TVariables, TOnMutateResult>, queryClient?: QueryClient): UseMutationResult<TData, TError, TVariables, TOnMutateResult>;
72
175
  //#endregion
@@ -1 +1 @@
1
- {"version":3,"file":"useMutation.d.cts","names":[],"sources":["../../src/useMutation.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsFgB,YACd,iBACA,SAAS,cACT,mBACA,2BAEA,SAAS,mBAAmB,OAAO,QAAQ,YAAY,kBACvD,cAAc,cACb,kBAAkB,OAAO,QAAQ,YAAY"}
1
+ {"version":3,"file":"useMutation.d.cts","names":[],"sources":["../../src/useMutation.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6LgB,YACd,iBACA,SAAS,cACT,mBACA,2BAEA,SAAS,mBAAmB,OAAO,QAAQ,YAAY,kBACvD,cAAc,cACb,kBAAkB,OAAO,QAAQ,YAAY"}