UNPKG

@connectrpc/connect-query

Version:

TypeScript-first expansion pack for TanStack Query that gives you Protobuf superpowers.

25 lines 1.77 kB
import type { Message, PartialMessage } from "@bufbuild/protobuf"; import type { ConnectError, Transport } from "@connectrpc/connect"; import type { InfiniteData, UseInfiniteQueryResult, UseSuspenseInfiniteQueryResult } from "@tanstack/react-query"; import type { CreateInfiniteQueryOptions, CreateSuspenseInfiniteQueryOptions } from "./create-use-infinite-query-options.js"; import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js"; import type { DisableQuery } from "./utils.js"; /** * Query the method provided. Maps to useInfiniteQuery on tanstack/react-query * * @param methodSig * @returns */ export declare function useInfiniteQuery<I extends Message<I>, O extends Message<O>, ParamKey extends keyof PartialMessage<I>>(methodSig: MethodUnaryDescriptor<I, O>, input: DisableQuery | (PartialMessage<I> & Required<Pick<PartialMessage<I>, ParamKey>>), { transport, callOptions, pageParamKey, getNextPageParam, ...options }: Omit<CreateInfiniteQueryOptions<I, O, ParamKey>, "transport"> & { transport?: Transport; }): UseInfiniteQueryResult<InfiniteData<O>, ConnectError>; /** * Query the method provided. Maps to useSuspenseInfiniteQuery on tanstack/react-query * * @param methodSig * @returns */ export declare function useSuspenseInfiniteQuery<I extends Message<I>, O extends Message<O>, ParamKey extends keyof PartialMessage<I>>(methodSig: MethodUnaryDescriptor<I, O>, input: PartialMessage<I> & Required<Pick<PartialMessage<I>, ParamKey>>, { transport, callOptions, pageParamKey, getNextPageParam, ...options }: Omit<CreateSuspenseInfiniteQueryOptions<I, O, ParamKey>, "transport"> & { transport?: Transport; }): UseSuspenseInfiniteQueryResult<InfiniteData<O>, ConnectError>; //# sourceMappingURL=use-infinite-query.d.ts.map