@suspensive/react-query-5/dist/SuspenseInfiniteQuery.d.cts

Suspensive interfaces for @tanstack/react-query@5

import * as _$react_jsx_runtime0 from "react/jsx-runtime";
import { DefaultError, InfiniteData, QueryKey, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from "@tanstack/react-query";
import { ReactNode } from "react";

//#region src/SuspenseInfiniteQuery.d.ts
/**
 * We provide these components to clearly express what causes suspense at the same depth.
 * `<SuspenseInfiniteQuery/>` serves to make `useSuspenseInfiniteQuery` easier to use in jsx.
 * @see {@link https://suspensive.org/docs/react-query/SuspenseInfiniteQuery Suspensive Docs}
 * @example
 * ```tsx
 * import { SuspenseInfiniteQuery } from '@suspensive/react-query'
 *
 * // You can use infiniteQueryOptions as props.
 * <SuspenseInfiniteQuery {...infiniteQueryOptions()}>
 *   {({ data, fetchNextPage }) => {
 *     return <></>
 *   }}
 * </SuspenseInfiniteQuery>
 * ```
 */
declare const SuspenseInfiniteQuery: <TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>({
  children,
  ...options
}: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & {
  children: (query: UseSuspenseInfiniteQueryResult<TData, TError>) => ReactNode;
}) => _$react_jsx_runtime0.JSX.Element;
//#endregion
export { SuspenseInfiniteQuery };
//# sourceMappingURL=SuspenseInfiniteQuery.d.cts.map