diff --git a/docs/config.json b/docs/config.json index 21737a4132..8fb4bacc6f 100644 --- a/docs/config.json +++ b/docs/config.json @@ -1402,89 +1402,85 @@ { "label": "preact", "children": [ - { - "label": "Preact Reference", - "to": "framework/preact/reference/index" - }, { "label": "useQuery", - "to": "framework/preact/reference/functions/useQuery" + "to": "framework/preact/reference/useQuery" }, { "label": "useQueries", - "to": "framework/preact/reference/functions/useQueries" + "to": "framework/preact/reference/useQueries" }, { "label": "useInfiniteQuery", - "to": "framework/preact/reference/functions/useInfiniteQuery" + "to": "framework/preact/reference/useInfiniteQuery" }, { "label": "useMutation", - "to": "framework/preact/reference/functions/useMutation" + "to": "framework/preact/reference/useMutation" }, { "label": "useIsFetching", - "to": "framework/preact/reference/functions/useIsFetching" + "to": "framework/preact/reference/useIsFetching" }, { "label": "useIsMutating", - "to": "framework/preact/reference/functions/useIsMutating" + "to": "framework/preact/reference/useIsMutating" }, { "label": "useMutationState", - "to": "framework/preact/reference/functions/useMutationState" + "to": "framework/preact/reference/useMutationState" }, { "label": "useSuspenseQuery", - "to": "framework/preact/reference/functions/useSuspenseQuery" + "to": "framework/preact/reference/useSuspenseQuery" }, { "label": "useSuspenseInfiniteQuery", - "to": "framework/preact/reference/functions/useSuspenseInfiniteQuery" + "to": "framework/preact/reference/useSuspenseInfiniteQuery" }, { "label": "useSuspenseQueries", - "to": "framework/preact/reference/functions/useSuspenseQueries" + "to": "framework/preact/reference/useSuspenseQueries" }, { "label": "QueryClientProvider", - "to": "framework/preact/reference/functions/QueryClientProvider" + "to": "framework/preact/reference/QueryClientProvider" }, { "label": "useQueryClient", - "to": "framework/preact/reference/functions/useQueryClient" + "to": "framework/preact/reference/useQueryClient" }, { "label": "queryOptions", - "to": "framework/preact/reference/functions/queryOptions" + "to": "framework/preact/reference/queryOptions" }, { "label": "infiniteQueryOptions", - "to": "framework/preact/reference/functions/infiniteQueryOptions" + "to": "framework/preact/reference/infiniteQueryOptions" }, { "label": "mutationOptions", - "to": "framework/preact/reference/functions/mutationOptions" + "to": "framework/preact/reference/mutationOptions" }, { "label": "usePrefetchQuery", - "to": "framework/preact/reference/functions/usePrefetchQuery" + "to": "framework/preact/reference/usePrefetchQuery" }, { "label": "usePrefetchInfiniteQuery", - "to": "framework/preact/reference/functions/usePrefetchInfiniteQuery" + "to": "framework/preact/reference/usePrefetchInfiniteQuery" }, { "label": "QueryErrorResetBoundary", - "to": "framework/preact/reference/functions/QueryErrorResetBoundary" + "to": "framework/preact/reference/QueryErrorResetBoundary" }, { "label": "useQueryErrorResetBoundary", - "to": "framework/preact/reference/functions/useQueryErrorResetBoundary" + "to": "framework/preact/reference/useQueryErrorResetBoundary" }, { "label": "hydration", - "to": "framework/preact/reference/functions/HydrationBoundary" + "to": "framework/preact/reference/hydration" } ] } diff --git a/docs/framework/preact/reference/QueryClientProvider.md b/docs/framework/preact/reference/QueryClientProvider.md new file mode 100644 index 0000000000..625c1d9757 --- /dev/null +++ b/docs/framework/preact/reference/QueryClientProvider.md @@ -0,0 +1,6 @@ +--- +id: QueryClientProvider +title: QueryClientProvider +ref: docs/framework/react/reference/QueryClientProvider.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/QueryErrorResetBoundary.md b/docs/framework/preact/reference/QueryErrorResetBoundary.md new file mode 100644 index 0000000000..77918c2459 --- /dev/null +++ b/docs/framework/preact/reference/QueryErrorResetBoundary.md @@ -0,0 +1,50 @@ +--- +id: QueryErrorResetBoundary +title: QueryErrorResetBoundary +ref: docs/framework/react/reference/QueryErrorResetBoundary.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- + +[//]: # 'ReactErrorBoundaryExample' + +Preact provides a [`useErrorBoundary` hook](https://preactjs.com/guide/v10/hooks/#useerrorboundary) that you can combine with `QueryErrorResetBoundary`'s `reset`: + +```tsx +import { QueryErrorResetBoundary } from '@tanstack/preact-query' +import type { ComponentChildren } from 'preact' +import { useErrorBoundary } from 'preact/hooks' + +function ErrorBoundary(props: { onReset: () => void; children: ComponentChildren }) { + const [error, resetError] = useErrorBoundary() + + if (error) { + return ( +
+ There was an error! + +
+ ) + } + + return props.children +} + +const App = () => ( + + {({ reset }) => ( + + + + )} + +) +``` + +[//]: # 'ReactErrorBoundaryExample' diff --git a/docs/framework/preact/reference/functions/HydrationBoundary.md b/docs/framework/preact/reference/functions/HydrationBoundary.md deleted file mode 100644 index 3d48a51149..0000000000 --- a/docs/framework/preact/reference/functions/HydrationBoundary.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: HydrationBoundary -title: HydrationBoundary ---- - -```ts -function HydrationBoundary(__namedParameters): Element; -``` - -Defined in: [preact-query/src/HydrationBoundary.tsx:26](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L26) - -## Parameters - -### \_\_namedParameters - -[`HydrationBoundaryProps`](../interfaces/HydrationBoundaryProps.md) - -## Returns - -`Element` diff --git a/docs/framework/preact/reference/functions/QueryClientProvider.md b/docs/framework/preact/reference/functions/QueryClientProvider.md deleted file mode 100644 index 2ac3ccfbda..0000000000 --- a/docs/framework/preact/reference/functions/QueryClientProvider.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: QueryClientProvider -title: QueryClientProvider ---- - -```ts -function QueryClientProvider(__namedParameters): VNode; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:29](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L29) - -## Parameters - -### \_\_namedParameters - -[`QueryClientProviderProps`](../type-aliases/QueryClientProviderProps.md) - -## Returns - -`VNode` diff --git a/docs/framework/preact/reference/functions/QueryErrorResetBoundary.md b/docs/framework/preact/reference/functions/QueryErrorResetBoundary.md deleted file mode 100644 index aa06d5317d..0000000000 --- a/docs/framework/preact/reference/functions/QueryErrorResetBoundary.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: QueryErrorResetBoundary -title: QueryErrorResetBoundary ---- - -```ts -function QueryErrorResetBoundary(__namedParameters): Element; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:48](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L48) - -## Parameters - -### \_\_namedParameters - -[`QueryErrorResetBoundaryProps`](../interfaces/QueryErrorResetBoundaryProps.md) - -## Returns - -`Element` diff --git a/docs/framework/preact/reference/functions/infiniteQueryOptions.md b/docs/framework/preact/reference/functions/infiniteQueryOptions.md deleted file mode 100644 index a9eb567c72..0000000000 --- a/docs/framework/preact/reference/functions/infiniteQueryOptions.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -id: infiniteQueryOptions -title: infiniteQueryOptions ---- - -## Call Signature - -```ts -function infiniteQueryOptions(options): UseInfiniteQueryOptions & object & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:76](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L76) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -### Returns - -[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object` - -## Call Signature - -```ts -function infiniteQueryOptions(options): OmitKeyof, "queryFn"> & object & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:100](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L100) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`UnusedSkipTokenInfiniteOptions`](../type-aliases/UnusedSkipTokenInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -### Returns - -`OmitKeyof`\<[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object` - -## Call Signature - -```ts -function infiniteQueryOptions(options): UseInfiniteQueryOptions & object & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:124](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L124) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -### Returns - -[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object` diff --git a/docs/framework/preact/reference/functions/mutationOptions.md b/docs/framework/preact/reference/functions/mutationOptions.md deleted file mode 100644 index a72866cc0a..0000000000 --- a/docs/framework/preact/reference/functions/mutationOptions.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: mutationOptions -title: mutationOptions ---- - -## Call Signature - -```ts -function mutationOptions(options): WithRequired, "mutationKey">; -``` - -Defined in: [preact-query/src/mutationOptions.ts:5](https://github.com/TanStack/query/blob/main/packages/preact-query/src/mutationOptions.ts#L5) - -### Type Parameters - -#### TData - -`TData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TVariables - -`TVariables` = `void` - -#### TOnMutateResult - -`TOnMutateResult` = `unknown` - -### Parameters - -#### options - -`WithRequired`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> - -### Returns - -`WithRequired`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> - -## Call Signature - -```ts -function mutationOptions(options): Omit, "mutationKey">; -``` - -Defined in: [preact-query/src/mutationOptions.ts:19](https://github.com/TanStack/query/blob/main/packages/preact-query/src/mutationOptions.ts#L19) - -### Type Parameters - -#### TData - -`TData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TVariables - -`TVariables` = `void` - -#### TOnMutateResult - -`TOnMutateResult` = `unknown` - -### Parameters - -#### options - -`Omit`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> - -### Returns - -`Omit`\<[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"mutationKey"`\> diff --git a/docs/framework/preact/reference/functions/queryOptions.md b/docs/framework/preact/reference/functions/queryOptions.md deleted file mode 100644 index 8791f8df66..0000000000 --- a/docs/framework/preact/reference/functions/queryOptions.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -id: queryOptions -title: queryOptions ---- - -## Call Signature - -```ts -function queryOptions(options): Omit, "queryFn"> & object & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:53](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L53) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -### Returns - -`Omit`\<[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object` - -## Call Signature - -```ts -function queryOptions(options): OmitKeyof, "queryFn"> & object & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:64](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L64) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -### Returns - -`OmitKeyof`\<[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> & `object` & `object` - -## Call Signature - -```ts -function queryOptions(options): UseQueryOptions & object & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:75](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L75) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -### Returns - -[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` & `object` diff --git a/docs/framework/preact/reference/functions/useInfiniteQuery.md b/docs/framework/preact/reference/functions/useInfiniteQuery.md deleted file mode 100644 index 87fa3c3fa5..0000000000 --- a/docs/framework/preact/reference/functions/useInfiniteQuery.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -id: useInfiniteQuery -title: useInfiniteQuery ---- - -## Call Signature - -```ts -function useInfiniteQuery(options, queryClient?): DefinedUseInfiniteQueryResult; -``` - -Defined in: [preact-query/src/useInfiniteQuery.ts:21](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L21) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`DefinedUseInfiniteQueryResult`](../type-aliases/DefinedUseInfiniteQueryResult.md)\<`TData`, `TError`\> - -## Call Signature - -```ts -function useInfiniteQuery(options, queryClient?): UseInfiniteQueryResult; -``` - -Defined in: [preact-query/src/useInfiniteQuery.ts:38](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L38) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`UseInfiniteQueryResult`](../type-aliases/UseInfiniteQueryResult.md)\<`TData`, `TError`\> - -## Call Signature - -```ts -function useInfiniteQuery(options, queryClient?): UseInfiniteQueryResult; -``` - -Defined in: [preact-query/src/useInfiniteQuery.ts:55](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useInfiniteQuery.ts#L55) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -#### TPageParam - -`TPageParam` = `unknown` - -### Parameters - -#### options - -[`UseInfiniteQueryOptions`](../interfaces/UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`UseInfiniteQueryResult`](../type-aliases/UseInfiniteQueryResult.md)\<`TData`, `TError`\> diff --git a/docs/framework/preact/reference/functions/useIsFetching.md b/docs/framework/preact/reference/functions/useIsFetching.md deleted file mode 100644 index 2e8d489d81..0000000000 --- a/docs/framework/preact/reference/functions/useIsFetching.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: useIsFetching -title: useIsFetching ---- - -```ts -function useIsFetching(filters?, queryClient?): number; -``` - -Defined in: [preact-query/src/useIsFetching.ts:8](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useIsFetching.ts#L8) - -## Parameters - -### filters? - -`QueryFilters`\ - -### queryClient? - -`QueryClient` - -## Returns - -`number` diff --git a/docs/framework/preact/reference/functions/useIsMutating.md b/docs/framework/preact/reference/functions/useIsMutating.md deleted file mode 100644 index 13327fc0ca..0000000000 --- a/docs/framework/preact/reference/functions/useIsMutating.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: useIsMutating -title: useIsMutating ---- - -```ts -function useIsMutating(filters?, queryClient?): number; -``` - -Defined in: [preact-query/src/useMutationState.ts:14](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useMutationState.ts#L14) - -## Parameters - -### filters? - -`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\> - -### queryClient? - -`QueryClient` - -## Returns - -`number` diff --git a/docs/framework/preact/reference/functions/useIsRestoring.md b/docs/framework/preact/reference/functions/useIsRestoring.md deleted file mode 100644 index 5b3b14ecd7..0000000000 --- a/docs/framework/preact/reference/functions/useIsRestoring.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: useIsRestoring -title: useIsRestoring ---- - -```ts -function useIsRestoring(): boolean; -``` - -Defined in: [preact-query/src/IsRestoringProvider.ts:6](https://github.com/TanStack/query/blob/main/packages/preact-query/src/IsRestoringProvider.ts#L6) - -## Returns - -`boolean` diff --git a/docs/framework/preact/reference/functions/useMutation.md b/docs/framework/preact/reference/functions/useMutation.md deleted file mode 100644 index 0a67753e61..0000000000 --- a/docs/framework/preact/reference/functions/useMutation.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: useMutation -title: useMutation ---- - -```ts -function useMutation(options, queryClient?): UseMutationResult; -``` - -Defined in: [preact-query/src/useMutation.ts:20](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useMutation.ts#L20) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `Error` - -### TVariables - -`TVariables` = `void` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` - -## Parameters - -### options - -[`UseMutationOptions`](../interfaces/UseMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\> - -### queryClient? - -`QueryClient` - -## Returns - -[`UseMutationResult`](../type-aliases/UseMutationResult.md)\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\> diff --git a/docs/framework/preact/reference/functions/useMutationState.md b/docs/framework/preact/reference/functions/useMutationState.md deleted file mode 100644 index 91efde3cc3..0000000000 --- a/docs/framework/preact/reference/functions/useMutationState.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: useMutationState -title: useMutationState ---- - -```ts -function useMutationState(options, queryClient?): TResult[]; -``` - -Defined in: [preact-query/src/useMutationState.ts:42](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useMutationState.ts#L42) - -## Type Parameters - -### TResult - -`TResult` = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\> - -## Parameters - -### options - -`MutationStateOptions`\<`TResult`\> = `{}` - -### queryClient? - -`QueryClient` - -## Returns - -`TResult`[] diff --git a/docs/framework/preact/reference/functions/usePrefetchInfiniteQuery.md b/docs/framework/preact/reference/functions/usePrefetchInfiniteQuery.md deleted file mode 100644 index ea76ffc475..0000000000 --- a/docs/framework/preact/reference/functions/usePrefetchInfiniteQuery.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: usePrefetchInfiniteQuery -title: usePrefetchInfiniteQuery ---- - -```ts -function usePrefetchInfiniteQuery(options, queryClient?): void; -``` - -Defined in: [preact-query/src/usePrefetchInfiniteQuery.tsx:10](https://github.com/TanStack/query/blob/main/packages/preact-query/src/usePrefetchInfiniteQuery.tsx#L10) - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `Error` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### TPageParam - -`TPageParam` = `unknown` - -## Parameters - -### options - -`FetchInfiniteQueryOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -### queryClient? - -`QueryClient` - -## Returns - -`void` diff --git a/docs/framework/preact/reference/functions/usePrefetchQuery.md b/docs/framework/preact/reference/functions/usePrefetchQuery.md deleted file mode 100644 index 2eddd78918..0000000000 --- a/docs/framework/preact/reference/functions/usePrefetchQuery.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: usePrefetchQuery -title: usePrefetchQuery ---- - -```ts -function usePrefetchQuery(options, queryClient?): void; -``` - -Defined in: [preact-query/src/usePrefetchQuery.tsx:6](https://github.com/TanStack/query/blob/main/packages/preact-query/src/usePrefetchQuery.tsx#L6) - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `Error` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -## Parameters - -### options - -[`UsePrefetchQueryOptions`](../interfaces/UsePrefetchQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -### queryClient? - -`QueryClient` - -## Returns - -`void` diff --git a/docs/framework/preact/reference/functions/useQueries.md b/docs/framework/preact/reference/functions/useQueries.md deleted file mode 100644 index 382fc00865..0000000000 --- a/docs/framework/preact/reference/functions/useQueries.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: useQueries -title: useQueries ---- - -```ts -function useQueries(__namedParameters, queryClient?): TCombinedResult; -``` - -Defined in: [preact-query/src/useQueries.ts:207](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L207) - -## Type Parameters - -### T - -`T` *extends* `any`[] - -### TCombinedResult - -`TCombinedResult` = `T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseQueryResult`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseQueryResult`\<`Head`\>, `GetUseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseQueryResult`\<`Head`\>, `GetUseQueryResult`\<`Head`\>, `GetUseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : \[`...{ [K in (...)]: (...) }[]`\] : \[...\{ \[K in string \| number \| symbol\]: GetUseQueryResult\\]\> \}\[\]\] : \{ \[K in string \| number \| symbol\]: GetUseQueryResult\\]\> \} - -## Parameters - -### \_\_namedParameters - -#### combine? - -(`result`) => `TCombinedResult` - -#### queries - - \| readonly \[`T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseQueryOptionsForUseQueries`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseQueryOptionsForUseQueries`\<`Head`\>, `GetUseQueryOptionsForUseQueries`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : readonly ...[] *extends* \[`...(...)[]`\] ? \[`...(...)[]`\] : ... *extends* ... ? ... : ... : readonly `unknown`[] *extends* `T` ? `T` : `T` *extends* `UseQueryOptionsForUseQueries`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] ? `UseQueryOptionsForUseQueries`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] : `UseQueryOptionsForUseQueries`\<`unknown`, `Error`, `unknown`, readonly ...[]\>[]\] - \| readonly \[\{ \[K in string \| number \| symbol\]: GetUseQueryOptionsForUseQueries\\]\> \}\] - -#### subscribed? - -`boolean` - -### queryClient? - -`QueryClient` - -## Returns - -`TCombinedResult` diff --git a/docs/framework/preact/reference/functions/useQuery.md b/docs/framework/preact/reference/functions/useQuery.md deleted file mode 100644 index cc06dae3e6..0000000000 --- a/docs/framework/preact/reference/functions/useQuery.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -id: useQuery -title: useQuery ---- - -## Call Signature - -```ts -function useQuery(options, queryClient?): DefinedUseQueryResult, TError>; -``` - -Defined in: [preact-query/src/useQuery.ts:15](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L15) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`DefinedUseQueryResult`](../type-aliases/DefinedUseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\> - -## Call Signature - -```ts -function useQuery(options, queryClient?): UseQueryResult, TError>; -``` - -Defined in: [preact-query/src/useQuery.ts:25](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L25) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`UseQueryResult`](../type-aliases/UseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\> - -## Call Signature - -```ts -function useQuery(options, queryClient?): UseQueryResult, TError>; -``` - -Defined in: [preact-query/src/useQuery.ts:35](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L35) - -### Type Parameters - -#### TQueryFnData - -`TQueryFnData` = `unknown` - -#### TError - -`TError` = `Error` - -#### TData - -`TData` = `TQueryFnData` - -#### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### Parameters - -#### options - -[`UseQueryOptions`](../interfaces/UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -#### queryClient? - -`QueryClient` - -### Returns - -[`UseQueryResult`](../type-aliases/UseQueryResult.md)\<`NoInfer`\<`TData`\>, `TError`\> diff --git a/docs/framework/preact/reference/functions/useQueryClient.md b/docs/framework/preact/reference/functions/useQueryClient.md deleted file mode 100644 index 61be8c5af4..0000000000 --- a/docs/framework/preact/reference/functions/useQueryClient.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: useQueryClient -title: useQueryClient ---- - -```ts -function useQueryClient(queryClient?): QueryClient; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:10](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L10) - -## Parameters - -### queryClient? - -`QueryClient` - -## Returns - -`QueryClient` diff --git a/docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md b/docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md deleted file mode 100644 index d9b96677a4..0000000000 --- a/docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: useQueryErrorResetBoundary -title: useQueryErrorResetBoundary ---- - -```ts -function useQueryErrorResetBoundary(): QueryErrorResetBoundaryValue; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:35](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L35) - -## Returns - -`QueryErrorResetBoundaryValue` diff --git a/docs/framework/preact/reference/functions/useSuspenseInfiniteQuery.md b/docs/framework/preact/reference/functions/useSuspenseInfiniteQuery.md deleted file mode 100644 index 230d861343..0000000000 --- a/docs/framework/preact/reference/functions/useSuspenseInfiniteQuery.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: useSuspenseInfiniteQuery -title: useSuspenseInfiniteQuery ---- - -```ts -function useSuspenseInfiniteQuery(options, queryClient?): UseSuspenseInfiniteQueryResult; -``` - -Defined in: [preact-query/src/useSuspenseInfiniteQuery.ts:18](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseInfiniteQuery.ts#L18) - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` - -### TError - -`TError` = `Error` - -### TData - -`TData` = `InfiniteData`\<`TQueryFnData`, `unknown`\> - -### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -### TPageParam - -`TPageParam` = `unknown` - -## Parameters - -### options - -[`UseSuspenseInfiniteQueryOptions`](../interfaces/UseSuspenseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -### queryClient? - -`QueryClient` - -## Returns - -[`UseSuspenseInfiniteQueryResult`](../type-aliases/UseSuspenseInfiniteQueryResult.md)\<`TData`, `TError`\> diff --git a/docs/framework/preact/reference/functions/useSuspenseQueries.md b/docs/framework/preact/reference/functions/useSuspenseQueries.md deleted file mode 100644 index 7fd0a76497..0000000000 --- a/docs/framework/preact/reference/functions/useSuspenseQueries.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: useSuspenseQueries -title: useSuspenseQueries ---- - -## Call Signature - -```ts -function useSuspenseQueries(options, queryClient?): TCombinedResult; -``` - -Defined in: [preact-query/src/useSuspenseQueries.ts:165](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L165) - -### Type Parameters - -#### T - -`T` *extends* `any`[] - -#### TCombinedResult - -`TCombinedResult` = `T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : \[`...{ [K in (...)]: (...) }[]`\] : \[...\{ \[K in string \| number \| symbol\]: GetUseSuspenseQueryResult\\]\> \}\[\]\] : \{ \[K in string \| number \| symbol\]: GetUseSuspenseQueryResult\\]\> \} - -### Parameters - -#### options - -##### combine? - -(`result`) => `TCombinedResult` - -##### queries - - \| readonly \[`T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseSuspenseQueryOptions`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryOptions`\<`Head`\>, `GetUseSuspenseQueryOptions`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : ...[] *extends* \[`...(...)[]`\] ? \[`...(...)[]`\] : ... *extends* ... ? ... : ... : `unknown`[] *extends* `T` ? `T` : `T` *extends* [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] ? [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] : [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`unknown`, `Error`, `unknown`, readonly ...[]\>[]\] - \| readonly \[\{ \[K in string \| number \| symbol\]: GetUseSuspenseQueryOptions\\]\> \}\] - -#### queryClient? - -`QueryClient` - -### Returns - -`TCombinedResult` - -## Call Signature - -```ts -function useSuspenseQueries(options, queryClient?): TCombinedResult; -``` - -Defined in: [preact-query/src/useSuspenseQueries.ts:178](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L178) - -### Type Parameters - -#### T - -`T` *extends* `any`[] - -#### TCombinedResult - -`TCombinedResult` = `T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>, `GetUseSuspenseQueryResult`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] *extends* \[\] ? \[\] : ... *extends* ... ? ... : ... : \[`...{ [K in (...)]: (...) }[]`\] : \[...\{ \[K in string \| number \| symbol\]: GetUseSuspenseQueryResult\\]\> \}\[\]\] : \{ \[K in string \| number \| symbol\]: GetUseSuspenseQueryResult\\]\> \} - -### Parameters - -#### options - -##### combine? - -(`result`) => `TCombinedResult` - -##### queries - -readonly \[`T` *extends* \[\] ? \[\] : `T` *extends* \[`Head`\] ? \[`GetUseSuspenseQueryOptions`\<`Head`\>\] : `T` *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...Tails[]`\] *extends* \[`Head`\] ? \[`GetUseSuspenseQueryOptions`\<`Head`\>, `GetUseSuspenseQueryOptions`\<`Head`\>\] : \[`...Tails[]`\] *extends* \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] *extends* \[\] ? \[\] : \[`...(...)[]`\] *extends* \[...\] ? \[..., ..., ...\] : ... *extends* ... ? ... : ... : `unknown`[] *extends* \[`...Tails[]`\] ? \[`...Tails[]`\] : \[`...(...)[]`\] *extends* ...[] ? ...[] : ...[] : `unknown`[] *extends* `T` ? `T` : `T` *extends* [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] ? [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>[] : [`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>[]\] - -#### queryClient? - -`QueryClient` - -### Returns - -`TCombinedResult` diff --git a/docs/framework/preact/reference/functions/useSuspenseQuery.md b/docs/framework/preact/reference/functions/useSuspenseQuery.md deleted file mode 100644 index 7750202206..0000000000 --- a/docs/framework/preact/reference/functions/useSuspenseQuery.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: useSuspenseQuery -title: useSuspenseQuery ---- - -```ts -function useSuspenseQuery(options, queryClient?): UseSuspenseQueryResult; -``` - -Defined in: [preact-query/src/useSuspenseQuery.ts:8](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQuery.ts#L8) - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `Error` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] - -## Parameters - -### options - -[`UseSuspenseQueryOptions`](../interfaces/UseSuspenseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> - -### queryClient? - -`QueryClient` - -## Returns - -[`UseSuspenseQueryResult`](../type-aliases/UseSuspenseQueryResult.md)\<`TData`, `TError`\> diff --git a/docs/framework/preact/reference/hydration.md b/docs/framework/preact/reference/hydration.md new file mode 100644 index 0000000000..0002e31149 --- /dev/null +++ b/docs/framework/preact/reference/hydration.md @@ -0,0 +1,6 @@ +--- +id: hydration +title: hydration +ref: docs/framework/react/reference/hydration.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md deleted file mode 100644 index ec26d5caf6..0000000000 --- a/docs/framework/preact/reference/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -id: "@tanstack/preact-query" -title: "@tanstack/preact-query" ---- - -## Interfaces - -- [HydrationBoundaryProps](interfaces/HydrationBoundaryProps.md) -- [QueryErrorResetBoundaryProps](interfaces/QueryErrorResetBoundaryProps.md) -- [UseBaseQueryOptions](interfaces/UseBaseQueryOptions.md) -- [UseInfiniteQueryOptions](interfaces/UseInfiniteQueryOptions.md) -- [UseMutationOptions](interfaces/UseMutationOptions.md) -- [UsePrefetchQueryOptions](interfaces/UsePrefetchQueryOptions.md) -- [UseQueryOptions](interfaces/UseQueryOptions.md) -- [UseSuspenseInfiniteQueryOptions](interfaces/UseSuspenseInfiniteQueryOptions.md) -- [UseSuspenseQueryOptions](interfaces/UseSuspenseQueryOptions.md) - -## Type Aliases - -- [AnyUseBaseQueryOptions](type-aliases/AnyUseBaseQueryOptions.md) -- [AnyUseInfiniteQueryOptions](type-aliases/AnyUseInfiniteQueryOptions.md) -- [AnyUseMutationOptions](type-aliases/AnyUseMutationOptions.md) -- [AnyUseQueryOptions](type-aliases/AnyUseQueryOptions.md) -- [AnyUseSuspenseInfiniteQueryOptions](type-aliases/AnyUseSuspenseInfiniteQueryOptions.md) -- [AnyUseSuspenseQueryOptions](type-aliases/AnyUseSuspenseQueryOptions.md) -- [DefinedInitialDataInfiniteOptions](type-aliases/DefinedInitialDataInfiniteOptions.md) -- [DefinedInitialDataOptions](type-aliases/DefinedInitialDataOptions.md) -- [DefinedUseInfiniteQueryResult](type-aliases/DefinedUseInfiniteQueryResult.md) -- [DefinedUseQueryResult](type-aliases/DefinedUseQueryResult.md) -- [QueriesOptions](type-aliases/QueriesOptions.md) -- [QueriesResults](type-aliases/QueriesResults.md) -- [QueryClientProviderProps](type-aliases/QueryClientProviderProps.md) -- [QueryErrorClearResetFunction](type-aliases/QueryErrorClearResetFunction.md) -- [QueryErrorIsResetFunction](type-aliases/QueryErrorIsResetFunction.md) -- [QueryErrorResetBoundaryFunction](type-aliases/QueryErrorResetBoundaryFunction.md) -- [QueryErrorResetFunction](type-aliases/QueryErrorResetFunction.md) -- [SuspenseQueriesOptions](type-aliases/SuspenseQueriesOptions.md) -- [SuspenseQueriesResults](type-aliases/SuspenseQueriesResults.md) -- [UndefinedInitialDataInfiniteOptions](type-aliases/UndefinedInitialDataInfiniteOptions.md) -- [UndefinedInitialDataOptions](type-aliases/UndefinedInitialDataOptions.md) -- [UnusedSkipTokenInfiniteOptions](type-aliases/UnusedSkipTokenInfiniteOptions.md) -- [UnusedSkipTokenOptions](type-aliases/UnusedSkipTokenOptions.md) -- [UseBaseMutationResult](type-aliases/UseBaseMutationResult.md) -- [UseBaseQueryResult](type-aliases/UseBaseQueryResult.md) -- [UseInfiniteQueryResult](type-aliases/UseInfiniteQueryResult.md) -- [UseMutateAsyncFunction](type-aliases/UseMutateAsyncFunction.md) -- [UseMutateFunction](type-aliases/UseMutateFunction.md) -- [UseMutationResult](type-aliases/UseMutationResult.md) -- [UseQueryResult](type-aliases/UseQueryResult.md) -- [UseSuspenseInfiniteQueryResult](type-aliases/UseSuspenseInfiniteQueryResult.md) -- [UseSuspenseQueryResult](type-aliases/UseSuspenseQueryResult.md) - -## Variables - -- [IsRestoringProvider](variables/IsRestoringProvider.md) -- [QueryClientContext](variables/QueryClientContext.md) - -## Functions - -- [HydrationBoundary](functions/HydrationBoundary.md) -- [infiniteQueryOptions](functions/infiniteQueryOptions.md) -- [mutationOptions](functions/mutationOptions.md) -- [QueryClientProvider](functions/QueryClientProvider.md) -- [QueryErrorResetBoundary](functions/QueryErrorResetBoundary.md) -- [queryOptions](functions/queryOptions.md) -- [useInfiniteQuery](functions/useInfiniteQuery.md) -- [useIsFetching](functions/useIsFetching.md) -- [useIsMutating](functions/useIsMutating.md) -- [useIsRestoring](functions/useIsRestoring.md) -- [useMutation](functions/useMutation.md) -- [useMutationState](functions/useMutationState.md) -- [usePrefetchInfiniteQuery](functions/usePrefetchInfiniteQuery.md) -- [usePrefetchQuery](functions/usePrefetchQuery.md) -- [useQueries](functions/useQueries.md) -- [useQuery](functions/useQuery.md) -- [useQueryClient](functions/useQueryClient.md) -- [useQueryErrorResetBoundary](functions/useQueryErrorResetBoundary.md) -- [useSuspenseInfiniteQuery](functions/useSuspenseInfiniteQuery.md) -- [useSuspenseQueries](functions/useSuspenseQueries.md) -- [useSuspenseQuery](functions/useSuspenseQuery.md) diff --git a/docs/framework/preact/reference/infiniteQueryOptions.md b/docs/framework/preact/reference/infiniteQueryOptions.md new file mode 100644 index 0000000000..0ead0f11fa --- /dev/null +++ b/docs/framework/preact/reference/infiniteQueryOptions.md @@ -0,0 +1,6 @@ +--- +id: infiniteQueryOptions +title: infiniteQueryOptions +ref: docs/framework/react/reference/infiniteQueryOptions.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/interfaces/HydrationBoundaryProps.md b/docs/framework/preact/reference/interfaces/HydrationBoundaryProps.md deleted file mode 100644 index 3470aedf9c..0000000000 --- a/docs/framework/preact/reference/interfaces/HydrationBoundaryProps.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: HydrationBoundaryProps -title: HydrationBoundaryProps ---- - -Defined in: [preact-query/src/HydrationBoundary.tsx:14](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L14) - -## Properties - -### children? - -```ts -optional children: ComponentChildren; -``` - -Defined in: [preact-query/src/HydrationBoundary.tsx:22](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L22) - -*** - -### options? - -```ts -optional options: OmitKeyof & object; -``` - -Defined in: [preact-query/src/HydrationBoundary.tsx:16](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L16) - -#### Type Declaration - -##### defaultOptions? - -```ts -optional defaultOptions: OmitKeyof<{ -}, "mutations">; -``` - -*** - -### queryClient? - -```ts -optional queryClient: QueryClient; -``` - -Defined in: [preact-query/src/HydrationBoundary.tsx:23](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L23) - -*** - -### state - -```ts -state: DehydratedState | null | undefined; -``` - -Defined in: [preact-query/src/HydrationBoundary.tsx:15](https://github.com/TanStack/query/blob/main/packages/preact-query/src/HydrationBoundary.tsx#L15) diff --git a/docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md b/docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md deleted file mode 100644 index ea3ebed77e..0000000000 --- a/docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: QueryErrorResetBoundaryProps -title: QueryErrorResetBoundaryProps ---- - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:44](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L44) - -## Properties - -### children - -```ts -children: - | ComponentChildren - | QueryErrorResetBoundaryFunction; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:45](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L45) diff --git a/docs/framework/preact/reference/interfaces/UseBaseQueryOptions.md b/docs/framework/preact/reference/interfaces/UseBaseQueryOptions.md deleted file mode 100644 index 0b1c2e8939..0000000000 --- a/docs/framework/preact/reference/interfaces/UseBaseQueryOptions.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: UseBaseQueryOptions -title: UseBaseQueryOptions ---- - -Defined in: [preact-query/src/types.ts:28](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L28) - -## Extends - -- `QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryData - -`TQueryData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -## Properties - -### subscribed? - -```ts -optional subscribed: boolean; -``` - -Defined in: [preact-query/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L45) - -Set this to `false` to unsubscribe this observer from updates to the query cache. -Defaults to `true`. diff --git a/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md b/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md deleted file mode 100644 index 898350f64e..0000000000 --- a/docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: UseInfiniteQueryOptions -title: UseInfiniteQueryOptions ---- - -Defined in: [preact-query/src/types.ts:102](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L102) - -## Extends - -- `OmitKeyof`\<`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"suspense"`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -### TPageParam - -`TPageParam` = `unknown` - -## Properties - -### subscribed? - -```ts -optional subscribed: boolean; -``` - -Defined in: [preact-query/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L122) - -Set this to `false` to unsubscribe this observer from updates to the query cache. -Defaults to `true`. diff --git a/docs/framework/preact/reference/interfaces/UseMutationOptions.md b/docs/framework/preact/reference/interfaces/UseMutationOptions.md deleted file mode 100644 index c496212a83..0000000000 --- a/docs/framework/preact/reference/interfaces/UseMutationOptions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: UseMutationOptions -title: UseMutationOptions ---- - -Defined in: [preact-query/src/types.ts:191](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L191) - -## Extends - -- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>, `"_defaulted"`\> - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TVariables - -`TVariables` = `void` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` diff --git a/docs/framework/preact/reference/interfaces/UsePrefetchQueryOptions.md b/docs/framework/preact/reference/interfaces/UsePrefetchQueryOptions.md deleted file mode 100644 index 5fdd4d15a7..0000000000 --- a/docs/framework/preact/reference/interfaces/UsePrefetchQueryOptions.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: UsePrefetchQueryOptions -title: UsePrefetchQueryOptions ---- - -Defined in: [preact-query/src/types.ts:48](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L48) - -## Extends - -- `OmitKeyof`\<`FetchQueryOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -## Properties - -### queryFn? - -```ts -optional queryFn: QueryFunction; -``` - -Defined in: [preact-query/src/types.ts:57](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L57) diff --git a/docs/framework/preact/reference/interfaces/UseQueryOptions.md b/docs/framework/preact/reference/interfaces/UseQueryOptions.md deleted file mode 100644 index 7e1dd38491..0000000000 --- a/docs/framework/preact/reference/interfaces/UseQueryOptions.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: UseQueryOptions -title: UseQueryOptions ---- - -Defined in: [preact-query/src/types.ts:64](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L64) - -## Extends - -- `OmitKeyof`\<[`UseBaseQueryOptions`](UseBaseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -## Properties - -### subscribed? - -```ts -optional subscribed: boolean; -``` - -Defined in: [preact-query/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L45) - -Set this to `false` to unsubscribe this observer from updates to the query cache. -Defaults to `true`. - -#### Inherited from - -```ts -OmitKeyof.subscribed -``` diff --git a/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md b/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md deleted file mode 100644 index 11e7e89f54..0000000000 --- a/docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: UseSuspenseInfiniteQueryOptions -title: UseSuspenseInfiniteQueryOptions ---- - -Defined in: [preact-query/src/types.ts:127](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L127) - -## Extends - -- `OmitKeyof`\<[`UseInfiniteQueryOptions`](UseInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"` \| `"enabled"` \| `"throwOnError"` \| `"placeholderData"`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -### TPageParam - -`TPageParam` = `unknown` - -## Properties - -### queryFn? - -```ts -optional queryFn: QueryFunction; -``` - -Defined in: [preact-query/src/types.ts:137](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L137) - -*** - -### subscribed? - -```ts -optional subscribed: boolean; -``` - -Defined in: [preact-query/src/types.ts:122](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L122) - -Set this to `false` to unsubscribe this observer from updates to the query cache. -Defaults to `true`. - -#### Inherited from - -```ts -OmitKeyof.subscribed -``` diff --git a/docs/framework/preact/reference/interfaces/UseSuspenseQueryOptions.md b/docs/framework/preact/reference/interfaces/UseSuspenseQueryOptions.md deleted file mode 100644 index f9013c37cb..0000000000 --- a/docs/framework/preact/reference/interfaces/UseSuspenseQueryOptions.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: UseSuspenseQueryOptions -title: UseSuspenseQueryOptions ---- - -Defined in: [preact-query/src/types.ts:80](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L80) - -## Extends - -- `OmitKeyof`\<[`UseQueryOptions`](UseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>, `"queryFn"` \| `"enabled"` \| `"throwOnError"` \| `"placeholderData"`\> - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -## Properties - -### queryFn? - -```ts -optional queryFn: QueryFunction; -``` - -Defined in: [preact-query/src/types.ts:89](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L89) - -*** - -### subscribed? - -```ts -optional subscribed: boolean; -``` - -Defined in: [preact-query/src/types.ts:45](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L45) - -Set this to `false` to unsubscribe this observer from updates to the query cache. -Defaults to `true`. - -#### Inherited from - -```ts -OmitKeyof.subscribed -``` diff --git a/docs/framework/preact/reference/mutationOptions.md b/docs/framework/preact/reference/mutationOptions.md new file mode 100644 index 0000000000..5921197ce3 --- /dev/null +++ b/docs/framework/preact/reference/mutationOptions.md @@ -0,0 +1,6 @@ +--- +id: mutationOptions +title: mutationOptions +ref: docs/framework/react/reference/mutationOptions.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/queryOptions.md b/docs/framework/preact/reference/queryOptions.md new file mode 100644 index 0000000000..ab44878c2b --- /dev/null +++ b/docs/framework/preact/reference/queryOptions.md @@ -0,0 +1,6 @@ +--- +id: queryOptions +title: queryOptions +ref: docs/framework/react/reference/queryOptions.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/type-aliases/AnyUseBaseQueryOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseBaseQueryOptions.md deleted file mode 100644 index 79092f325d..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseBaseQueryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseBaseQueryOptions -title: AnyUseBaseQueryOptions ---- - -```ts -type AnyUseBaseQueryOptions = UseBaseQueryOptions; -``` - -Defined in: [preact-query/src/types.ts:21](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L21) diff --git a/docs/framework/preact/reference/type-aliases/AnyUseInfiniteQueryOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseInfiniteQueryOptions.md deleted file mode 100644 index cfa929a5b6..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseInfiniteQueryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseInfiniteQueryOptions -title: AnyUseInfiniteQueryOptions ---- - -```ts -type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions; -``` - -Defined in: [preact-query/src/types.ts:95](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L95) diff --git a/docs/framework/preact/reference/type-aliases/AnyUseMutationOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseMutationOptions.md deleted file mode 100644 index d173591237..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseMutationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseMutationOptions -title: AnyUseMutationOptions ---- - -```ts -type AnyUseMutationOptions = UseMutationOptions; -``` - -Defined in: [preact-query/src/types.ts:190](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L190) diff --git a/docs/framework/preact/reference/type-aliases/AnyUseQueryOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseQueryOptions.md deleted file mode 100644 index d36e23e4cd..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseQueryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseQueryOptions -title: AnyUseQueryOptions ---- - -```ts -type AnyUseQueryOptions = UseQueryOptions; -``` - -Defined in: [preact-query/src/types.ts:63](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L63) diff --git a/docs/framework/preact/reference/type-aliases/AnyUseSuspenseInfiniteQueryOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseSuspenseInfiniteQueryOptions.md deleted file mode 100644 index 2fb1eebaf9..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseSuspenseInfiniteQueryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseSuspenseInfiniteQueryOptions -title: AnyUseSuspenseInfiniteQueryOptions ---- - -```ts -type AnyUseSuspenseInfiniteQueryOptions = UseSuspenseInfiniteQueryOptions; -``` - -Defined in: [preact-query/src/types.ts:125](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L125) diff --git a/docs/framework/preact/reference/type-aliases/AnyUseSuspenseQueryOptions.md b/docs/framework/preact/reference/type-aliases/AnyUseSuspenseQueryOptions.md deleted file mode 100644 index 2312acd6d6..0000000000 --- a/docs/framework/preact/reference/type-aliases/AnyUseSuspenseQueryOptions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: AnyUseSuspenseQueryOptions -title: AnyUseSuspenseQueryOptions ---- - -```ts -type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions; -``` - -Defined in: [preact-query/src/types.ts:74](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L74) diff --git a/docs/framework/preact/reference/type-aliases/DefinedInitialDataInfiniteOptions.md b/docs/framework/preact/reference/type-aliases/DefinedInitialDataInfiniteOptions.md deleted file mode 100644 index 38bd4b91fa..0000000000 --- a/docs/framework/preact/reference/type-aliases/DefinedInitialDataInfiniteOptions.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: DefinedInitialDataInfiniteOptions -title: DefinedInitialDataInfiniteOptions ---- - -```ts -type DefinedInitialDataInfiniteOptions = UseInfiniteQueryOptions & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:57](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L57) - -## Type Declaration - -### initialData - -```ts -initialData: - | NonUndefinedGuard> - | () => NonUndefinedGuard> - | undefined; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `InfiniteData`\<`TQueryFnData`\> - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -### TPageParam - -`TPageParam` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/DefinedInitialDataOptions.md b/docs/framework/preact/reference/type-aliases/DefinedInitialDataOptions.md deleted file mode 100644 index d91681471c..0000000000 --- a/docs/framework/preact/reference/type-aliases/DefinedInitialDataOptions.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: DefinedInitialDataOptions -title: DefinedInitialDataOptions ---- - -```ts -type DefinedInitialDataOptions = Omit, "queryFn"> & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:41](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L41) - -## Type Declaration - -### initialData - -```ts -initialData: - | NonUndefinedGuard -| () => NonUndefinedGuard; -``` - -### queryFn? - -```ts -optional queryFn: QueryFunction; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/preact/reference/type-aliases/DefinedUseInfiniteQueryResult.md b/docs/framework/preact/reference/type-aliases/DefinedUseInfiniteQueryResult.md deleted file mode 100644 index e455aec068..0000000000 --- a/docs/framework/preact/reference/type-aliases/DefinedUseInfiniteQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: DefinedUseInfiniteQueryResult -title: DefinedUseInfiniteQueryResult ---- - -```ts -type DefinedUseInfiniteQueryResult = DefinedInfiniteQueryObserverResult; -``` - -Defined in: [preact-query/src/types.ts:177](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L177) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/DefinedUseQueryResult.md b/docs/framework/preact/reference/type-aliases/DefinedUseQueryResult.md deleted file mode 100644 index ea49f9c1af..0000000000 --- a/docs/framework/preact/reference/type-aliases/DefinedUseQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: DefinedUseQueryResult -title: DefinedUseQueryResult ---- - -```ts -type DefinedUseQueryResult = DefinedQueryObserverResult; -``` - -Defined in: [preact-query/src/types.ts:167](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L167) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/QueriesOptions.md b/docs/framework/preact/reference/type-aliases/QueriesOptions.md deleted file mode 100644 index e77a924cbf..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueriesOptions.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: QueriesOptions -title: QueriesOptions ---- - -```ts -type QueriesOptions = TDepth["length"] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQueryOptionsForUseQueries] : T extends [infer Head, ...(infer Tails)] ? QueriesOptions<[...Tails], [...TResults, GetUseQueryOptionsForUseQueries], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends UseQueryOptionsForUseQueries[] ? UseQueryOptionsForUseQueries[] : UseQueryOptionsForUseQueries[]; -``` - -Defined in: [preact-query/src/useQueries.ts:147](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L147) - -QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param - -## Type Parameters - -### T - -`T` *extends* `any`[] - -### TResults - -`TResults` *extends* `any`[] = \[\] - -### TDepth - -`TDepth` *extends* `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/preact/reference/type-aliases/QueriesResults.md b/docs/framework/preact/reference/type-aliases/QueriesResults.md deleted file mode 100644 index a53dc3aa8d..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueriesResults.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: QueriesResults -title: QueriesResults ---- - -```ts -type QueriesResults = TDepth["length"] extends MAXIMUM_DEPTH ? UseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQueryResult] : T extends [infer Head, ...(infer Tails)] ? QueriesResults<[...Tails], [...TResults, GetUseQueryResult], [...TDepth, 1]> : { [K in keyof T]: GetUseQueryResult }; -``` - -Defined in: [preact-query/src/useQueries.ts:189](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L189) - -QueriesResults reducer recursively maps type param to results - -## Type Parameters - -### T - -`T` *extends* `any`[] - -### TResults - -`TResults` *extends* `any`[] = \[\] - -### TDepth - -`TDepth` *extends* `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md b/docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md deleted file mode 100644 index 0d835b30c9..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: QueryClientProviderProps -title: QueryClientProviderProps ---- - -```ts -type QueryClientProviderProps = object; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:24](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L24) - -## Properties - -### children? - -```ts -optional children: ComponentChildren; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:26](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L26) - -*** - -### client - -```ts -client: QueryClient; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:25](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L25) diff --git a/docs/framework/preact/reference/type-aliases/QueryErrorClearResetFunction.md b/docs/framework/preact/reference/type-aliases/QueryErrorClearResetFunction.md deleted file mode 100644 index 26cbffd963..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueryErrorClearResetFunction.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: QueryErrorClearResetFunction -title: QueryErrorClearResetFunction ---- - -```ts -type QueryErrorClearResetFunction = () => void; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:8](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L8) - -## Returns - -`void` diff --git a/docs/framework/preact/reference/type-aliases/QueryErrorIsResetFunction.md b/docs/framework/preact/reference/type-aliases/QueryErrorIsResetFunction.md deleted file mode 100644 index 3c08a571ff..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueryErrorIsResetFunction.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: QueryErrorIsResetFunction -title: QueryErrorIsResetFunction ---- - -```ts -type QueryErrorIsResetFunction = () => boolean; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:7](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L7) - -## Returns - -`boolean` diff --git a/docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md b/docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md deleted file mode 100644 index 4d6027cea0..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: QueryErrorResetBoundaryFunction -title: QueryErrorResetBoundaryFunction ---- - -```ts -type QueryErrorResetBoundaryFunction = (value) => ComponentChildren; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:40](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L40) - -## Parameters - -### value - -`QueryErrorResetBoundaryValue` - -## Returns - -`ComponentChildren` diff --git a/docs/framework/preact/reference/type-aliases/QueryErrorResetFunction.md b/docs/framework/preact/reference/type-aliases/QueryErrorResetFunction.md deleted file mode 100644 index 09ad00e7f9..0000000000 --- a/docs/framework/preact/reference/type-aliases/QueryErrorResetFunction.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: QueryErrorResetFunction -title: QueryErrorResetFunction ---- - -```ts -type QueryErrorResetFunction = () => void; -``` - -Defined in: [preact-query/src/QueryErrorResetBoundary.tsx:6](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryErrorResetBoundary.tsx#L6) - -## Returns - -`void` diff --git a/docs/framework/preact/reference/type-aliases/SuspenseQueriesOptions.md b/docs/framework/preact/reference/type-aliases/SuspenseQueriesOptions.md deleted file mode 100644 index 758ec7acb2..0000000000 --- a/docs/framework/preact/reference/type-aliases/SuspenseQueriesOptions.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: SuspenseQueriesOptions -title: SuspenseQueriesOptions ---- - -```ts -type SuspenseQueriesOptions = TDepth["length"] extends MAXIMUM_DEPTH ? UseSuspenseQueryOptions[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseSuspenseQueryOptions] : T extends [infer Head, ...(infer Tails)] ? SuspenseQueriesOptions<[...Tails], [...TResults, GetUseSuspenseQueryOptions], [...TDepth, 1]> : unknown[] extends T ? T : T extends UseSuspenseQueryOptions[] ? UseSuspenseQueryOptions[] : UseSuspenseQueryOptions[]; -``` - -Defined in: [preact-query/src/useSuspenseQueries.ts:110](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L110) - -SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param - -## Type Parameters - -### T - -`T` *extends* `any`[] - -### TResults - -`TResults` *extends* `any`[] = \[\] - -### TDepth - -`TDepth` *extends* `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/preact/reference/type-aliases/SuspenseQueriesResults.md b/docs/framework/preact/reference/type-aliases/SuspenseQueriesResults.md deleted file mode 100644 index a9a1144d66..0000000000 --- a/docs/framework/preact/reference/type-aliases/SuspenseQueriesResults.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: SuspenseQueriesResults -title: SuspenseQueriesResults ---- - -```ts -type SuspenseQueriesResults = TDepth["length"] extends MAXIMUM_DEPTH ? UseSuspenseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseSuspenseQueryResult] : T extends [infer Head, ...(infer Tails)] ? SuspenseQueriesResults<[...Tails], [...TResults, GetUseSuspenseQueryResult], [...TDepth, 1]> : { [K in keyof T]: GetUseSuspenseQueryResult }; -``` - -Defined in: [preact-query/src/useSuspenseQueries.ts:147](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L147) - -SuspenseQueriesResults reducer recursively maps type param to results - -## Type Parameters - -### T - -`T` *extends* `any`[] - -### TResults - -`TResults` *extends* `any`[] = \[\] - -### TDepth - -`TDepth` *extends* `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/preact/reference/type-aliases/UndefinedInitialDataInfiniteOptions.md b/docs/framework/preact/reference/type-aliases/UndefinedInitialDataInfiniteOptions.md deleted file mode 100644 index 74d4863c67..0000000000 --- a/docs/framework/preact/reference/type-aliases/UndefinedInitialDataInfiniteOptions.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: UndefinedInitialDataInfiniteOptions -title: UndefinedInitialDataInfiniteOptions ---- - -```ts -type UndefinedInitialDataInfiniteOptions = UseInfiniteQueryOptions & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:14](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L14) - -## Type Declaration - -### initialData? - -```ts -optional initialData: - | NonUndefinedGuard> -| InitialDataFunction>>; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `InfiniteData`\<`TQueryFnData`\> - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -### TPageParam - -`TPageParam` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/UndefinedInitialDataOptions.md b/docs/framework/preact/reference/type-aliases/UndefinedInitialDataOptions.md deleted file mode 100644 index 97523af511..0000000000 --- a/docs/framework/preact/reference/type-aliases/UndefinedInitialDataOptions.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: UndefinedInitialDataOptions -title: UndefinedInitialDataOptions ---- - -```ts -type UndefinedInitialDataOptions = UseQueryOptions & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:14](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L14) - -## Type Declaration - -### initialData? - -```ts -optional initialData: - | InitialDataFunction> -| NonUndefinedGuard; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/preact/reference/type-aliases/UnusedSkipTokenInfiniteOptions.md b/docs/framework/preact/reference/type-aliases/UnusedSkipTokenInfiniteOptions.md deleted file mode 100644 index d5a6f8a455..0000000000 --- a/docs/framework/preact/reference/type-aliases/UnusedSkipTokenInfiniteOptions.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: UnusedSkipTokenInfiniteOptions -title: UnusedSkipTokenInfiniteOptions ---- - -```ts -type UnusedSkipTokenInfiniteOptions = OmitKeyof, "queryFn"> & object; -``` - -Defined in: [preact-query/src/infiniteQueryOptions.ts:35](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L35) - -## Type Declaration - -### queryFn? - -```ts -optional queryFn: Exclude["queryFn"], SkipToken | undefined>; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `InfiniteData`\<`TQueryFnData`\> - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` - -### TPageParam - -`TPageParam` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/UnusedSkipTokenOptions.md b/docs/framework/preact/reference/type-aliases/UnusedSkipTokenOptions.md deleted file mode 100644 index f298f01c8c..0000000000 --- a/docs/framework/preact/reference/type-aliases/UnusedSkipTokenOptions.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: UnusedSkipTokenOptions -title: UnusedSkipTokenOptions ---- - -```ts -type UnusedSkipTokenOptions = OmitKeyof, "queryFn"> & object; -``` - -Defined in: [preact-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L26) - -## Type Declaration - -### queryFn? - -```ts -optional queryFn: Exclude["queryFn"], SkipToken | undefined>; -``` - -## Type Parameters - -### TQueryFnData - -`TQueryFnData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TData - -`TData` = `TQueryFnData` - -### TQueryKey - -`TQueryKey` *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md b/docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md deleted file mode 100644 index 8c585627b0..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: UseBaseMutationResult -title: UseBaseMutationResult ---- - -```ts -type UseBaseMutationResult = Override, { - mutate: UseMutateFunction; -}> & object; -``` - -Defined in: [preact-query/src/types.ts:219](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L219) - -## Type Declaration - -### mutateAsync - -```ts -mutateAsync: UseMutateAsyncFunction; -``` - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TVariables - -`TVariables` = `unknown` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/UseBaseQueryResult.md b/docs/framework/preact/reference/type-aliases/UseBaseQueryResult.md deleted file mode 100644 index 707837124d..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseBaseQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: UseBaseQueryResult -title: UseBaseQueryResult ---- - -```ts -type UseBaseQueryResult = QueryObserverResult; -``` - -Defined in: [preact-query/src/types.ts:149](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L149) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/UseInfiniteQueryResult.md b/docs/framework/preact/reference/type-aliases/UseInfiniteQueryResult.md deleted file mode 100644 index b5930d42d3..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseInfiniteQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: UseInfiniteQueryResult -title: UseInfiniteQueryResult ---- - -```ts -type UseInfiniteQueryResult = InfiniteQueryObserverResult; -``` - -Defined in: [preact-query/src/types.ts:172](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L172) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md b/docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md deleted file mode 100644 index ac21ee18a6..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: UseMutateAsyncFunction -title: UseMutateAsyncFunction ---- - -```ts -type UseMutateAsyncFunction = MutateFunction; -``` - -Defined in: [preact-query/src/types.ts:212](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L212) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TVariables - -`TVariables` = `void` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/UseMutateFunction.md b/docs/framework/preact/reference/type-aliases/UseMutateFunction.md deleted file mode 100644 index 526679960c..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseMutateFunction.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: UseMutateFunction -title: UseMutateFunction ---- - -```ts -type UseMutateFunction = (...args) => void; -``` - -Defined in: [preact-query/src/types.ts:201](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L201) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TVariables - -`TVariables` = `void` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` - -## Parameters - -### args - -...`Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TOnMutateResult`\>\> - -## Returns - -`void` diff --git a/docs/framework/preact/reference/type-aliases/UseMutationResult.md b/docs/framework/preact/reference/type-aliases/UseMutationResult.md deleted file mode 100644 index 69f0c6fb8d..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseMutationResult.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: UseMutationResult -title: UseMutationResult ---- - -```ts -type UseMutationResult = UseBaseMutationResult; -``` - -Defined in: [preact-query/src/types.ts:236](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L236) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` - -### TVariables - -`TVariables` = `unknown` - -### TOnMutateResult - -`TOnMutateResult` = `unknown` diff --git a/docs/framework/preact/reference/type-aliases/UseQueryResult.md b/docs/framework/preact/reference/type-aliases/UseQueryResult.md deleted file mode 100644 index 9f393a9498..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: UseQueryResult -title: UseQueryResult ---- - -```ts -type UseQueryResult = UseBaseQueryResult; -``` - -Defined in: [preact-query/src/types.ts:154](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L154) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/UseSuspenseInfiniteQueryResult.md b/docs/framework/preact/reference/type-aliases/UseSuspenseInfiniteQueryResult.md deleted file mode 100644 index 558fbf81a1..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseSuspenseInfiniteQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: UseSuspenseInfiniteQueryResult -title: UseSuspenseInfiniteQueryResult ---- - -```ts -type UseSuspenseInfiniteQueryResult = OmitKeyof, "isPlaceholderData" | "promise">; -``` - -Defined in: [preact-query/src/types.ts:182](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L182) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/type-aliases/UseSuspenseQueryResult.md b/docs/framework/preact/reference/type-aliases/UseSuspenseQueryResult.md deleted file mode 100644 index 62394407d5..0000000000 --- a/docs/framework/preact/reference/type-aliases/UseSuspenseQueryResult.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: UseSuspenseQueryResult -title: UseSuspenseQueryResult ---- - -```ts -type UseSuspenseQueryResult = DistributiveOmit, "isPlaceholderData" | "promise">; -``` - -Defined in: [preact-query/src/types.ts:159](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L159) - -## Type Parameters - -### TData - -`TData` = `unknown` - -### TError - -`TError` = `DefaultError` diff --git a/docs/framework/preact/reference/useInfiniteQuery.md b/docs/framework/preact/reference/useInfiniteQuery.md new file mode 100644 index 0000000000..35d3603fb7 --- /dev/null +++ b/docs/framework/preact/reference/useInfiniteQuery.md @@ -0,0 +1,9 @@ +--- +id: useInfiniteQuery +title: useInfiniteQuery +ref: docs/framework/react/reference/useInfiniteQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- + +[//]: # 'ReactUse' +[//]: # 'ReactUse' diff --git a/docs/framework/preact/reference/useIsFetching.md b/docs/framework/preact/reference/useIsFetching.md new file mode 100644 index 0000000000..d04e97ccd5 --- /dev/null +++ b/docs/framework/preact/reference/useIsFetching.md @@ -0,0 +1,6 @@ +--- +id: useIsFetching +title: useIsFetching +ref: docs/framework/react/reference/useIsFetching.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useIsMutating.md b/docs/framework/preact/reference/useIsMutating.md new file mode 100644 index 0000000000..3c96c726c3 --- /dev/null +++ b/docs/framework/preact/reference/useIsMutating.md @@ -0,0 +1,6 @@ +--- +id: useIsMutating +title: useIsMutating +ref: docs/framework/react/reference/useIsMutating.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useMutation.md b/docs/framework/preact/reference/useMutation.md new file mode 100644 index 0000000000..e6d3734e9c --- /dev/null +++ b/docs/framework/preact/reference/useMutation.md @@ -0,0 +1,6 @@ +--- +id: useMutation +title: useMutation +ref: docs/framework/react/reference/useMutation.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useMutationState.md b/docs/framework/preact/reference/useMutationState.md new file mode 100644 index 0000000000..0dfda17f6a --- /dev/null +++ b/docs/framework/preact/reference/useMutationState.md @@ -0,0 +1,6 @@ +--- +id: useMutationState +title: useMutationState +ref: docs/framework/react/reference/useMutationState.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/usePrefetchInfiniteQuery.md b/docs/framework/preact/reference/usePrefetchInfiniteQuery.md new file mode 100644 index 0000000000..a664f5e2ec --- /dev/null +++ b/docs/framework/preact/reference/usePrefetchInfiniteQuery.md @@ -0,0 +1,6 @@ +--- +id: usePrefetchInfiniteQuery +title: usePrefetchInfiniteQuery +ref: docs/framework/react/reference/usePrefetchInfiniteQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/usePrefetchQuery.md b/docs/framework/preact/reference/usePrefetchQuery.md new file mode 100644 index 0000000000..0849a29e14 --- /dev/null +++ b/docs/framework/preact/reference/usePrefetchQuery.md @@ -0,0 +1,6 @@ +--- +id: usePrefetchQuery +title: usePrefetchQuery +ref: docs/framework/react/reference/usePrefetchQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useQueries.md b/docs/framework/preact/reference/useQueries.md new file mode 100644 index 0000000000..0113f3ebda --- /dev/null +++ b/docs/framework/preact/reference/useQueries.md @@ -0,0 +1,6 @@ +--- +id: useQueries +title: useQueries +ref: docs/framework/react/reference/useQueries.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useQuery.md b/docs/framework/preact/reference/useQuery.md new file mode 100644 index 0000000000..fa8e312c47 --- /dev/null +++ b/docs/framework/preact/reference/useQuery.md @@ -0,0 +1,6 @@ +--- +id: useQuery +title: useQuery +ref: docs/framework/react/reference/useQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useQueryClient.md b/docs/framework/preact/reference/useQueryClient.md new file mode 100644 index 0000000000..a332f9f916 --- /dev/null +++ b/docs/framework/preact/reference/useQueryClient.md @@ -0,0 +1,6 @@ +--- +id: useQueryClient +title: useQueryClient +ref: docs/framework/react/reference/useQueryClient.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useQueryErrorResetBoundary.md b/docs/framework/preact/reference/useQueryErrorResetBoundary.md new file mode 100644 index 0000000000..49d0e1fe7a --- /dev/null +++ b/docs/framework/preact/reference/useQueryErrorResetBoundary.md @@ -0,0 +1,40 @@ +--- +id: useQueryErrorResetBoundary +title: useQueryErrorResetBoundary +ref: docs/framework/react/reference/useQueryErrorResetBoundary.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- + +[//]: # 'ReactErrorBoundaryExample' + +Preact provides a [`useErrorBoundary` hook](https://preactjs.com/guide/v10/hooks/#useerrorboundary) that you can combine with `useQueryErrorResetBoundary`'s `reset`: + +```tsx +import { useQueryErrorResetBoundary } from '@tanstack/preact-query' +import { useErrorBoundary } from 'preact/hooks' + +const App = () => { + const { reset } = useQueryErrorResetBoundary() + const [error, resetError] = useErrorBoundary() + + if (error) { + return ( +
+ There was an error! + +
+ ) + } + + return +} +``` + +[//]: # 'ReactErrorBoundaryExample' diff --git a/docs/framework/preact/reference/useSuspenseInfiniteQuery.md b/docs/framework/preact/reference/useSuspenseInfiniteQuery.md new file mode 100644 index 0000000000..525a0ebbf0 --- /dev/null +++ b/docs/framework/preact/reference/useSuspenseInfiniteQuery.md @@ -0,0 +1,6 @@ +--- +id: useSuspenseInfiniteQuery +title: useSuspenseInfiniteQuery +ref: docs/framework/react/reference/useSuspenseInfiniteQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useSuspenseQueries.md b/docs/framework/preact/reference/useSuspenseQueries.md new file mode 100644 index 0000000000..cf5f1fe8da --- /dev/null +++ b/docs/framework/preact/reference/useSuspenseQueries.md @@ -0,0 +1,6 @@ +--- +id: useSuspenseQueries +title: useSuspenseQueries +ref: docs/framework/react/reference/useSuspenseQueries.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/useSuspenseQuery.md b/docs/framework/preact/reference/useSuspenseQuery.md new file mode 100644 index 0000000000..38f8cab115 --- /dev/null +++ b/docs/framework/preact/reference/useSuspenseQuery.md @@ -0,0 +1,6 @@ +--- +id: useSuspenseQuery +title: useSuspenseQuery +ref: docs/framework/react/reference/useSuspenseQuery.md +replace: { '@tanstack/react-query': '@tanstack/preact-query' } +--- diff --git a/docs/framework/preact/reference/variables/IsRestoringProvider.md b/docs/framework/preact/reference/variables/IsRestoringProvider.md deleted file mode 100644 index e7844f01c8..0000000000 --- a/docs/framework/preact/reference/variables/IsRestoringProvider.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: IsRestoringProvider -title: IsRestoringProvider ---- - -```ts -const IsRestoringProvider: Provider = IsRestoringContext.Provider; -``` - -Defined in: [preact-query/src/IsRestoringProvider.ts:7](https://github.com/TanStack/query/blob/main/packages/preact-query/src/IsRestoringProvider.ts#L7) diff --git a/docs/framework/preact/reference/variables/QueryClientContext.md b/docs/framework/preact/reference/variables/QueryClientContext.md deleted file mode 100644 index ea5b0b0708..0000000000 --- a/docs/framework/preact/reference/variables/QueryClientContext.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: QueryClientContext -title: QueryClientContext ---- - -```ts -const QueryClientContext: Context; -``` - -Defined in: [preact-query/src/QueryClientProvider.tsx:6](https://github.com/TanStack/query/blob/main/packages/preact-query/src/QueryClientProvider.tsx#L6) diff --git a/docs/framework/react/reference/QueryErrorResetBoundary.md b/docs/framework/react/reference/QueryErrorResetBoundary.md index d1182bab5b..dde52367ab 100644 --- a/docs/framework/react/reference/QueryErrorResetBoundary.md +++ b/docs/framework/react/reference/QueryErrorResetBoundary.md @@ -5,6 +5,8 @@ title: QueryErrorResetBoundary When using **suspense** or **throwOnError** in your queries, you need a way to let queries know that you want to try again when re-rendering after some error occurred. With the `QueryErrorResetBoundary` component you can reset any query errors within the boundaries of the component. +[//]: # 'ReactErrorBoundaryExample' + ```tsx import { QueryErrorResetBoundary } from '@tanstack/react-query' import { ErrorBoundary } from 'react-error-boundary' @@ -27,3 +29,5 @@ const App = () => ( ) ``` + +[//]: # 'ReactErrorBoundaryExample' diff --git a/docs/framework/react/reference/useQueryErrorResetBoundary.md b/docs/framework/react/reference/useQueryErrorResetBoundary.md index 9c970678be..a98b76ca88 100644 --- a/docs/framework/react/reference/useQueryErrorResetBoundary.md +++ b/docs/framework/react/reference/useQueryErrorResetBoundary.md @@ -5,6 +5,8 @@ title: useQueryErrorResetBoundary This hook will reset any query errors within the closest `QueryErrorResetBoundary`. If there is no boundary defined it will reset them globally: +[//]: # 'ReactErrorBoundaryExample' + ```tsx import { useQueryErrorResetBoundary } from '@tanstack/react-query' import { ErrorBoundary } from 'react-error-boundary' @@ -26,3 +28,5 @@ const App = () => { ) } ``` + +[//]: # 'ReactErrorBoundaryExample'