UNPKG

@connectrpc/connect-query

Version:

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

25 lines 1.45 kB
import type { Message, PartialMessage } from "@bufbuild/protobuf"; import type { ConnectError, Transport } from "@connectrpc/connect"; import type { UseQueryResult, UseSuspenseQueryResult } from "@tanstack/react-query"; import type { CreateQueryOptions, CreateSuspenseQueryOptions } from "./create-use-query-options.js"; import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js"; import type { DisableQuery } from "./utils.js"; /** * Query the method provided. Maps to useQuery on tanstack/react-query * * @param methodSig * @returns */ export declare function useQuery<I extends Message<I>, O extends Message<O>, SelectOutData = O>(methodSig: MethodUnaryDescriptor<I, O>, input?: DisableQuery | PartialMessage<I>, { transport, callOptions, ...queryOptions }?: Omit<CreateQueryOptions<I, O, SelectOutData>, "transport"> & { transport?: Transport; }): UseQueryResult<SelectOutData, ConnectError>; /** * Query the method provided. Maps to useSuspenseQuery on tanstack/react-query * * @param methodSig * @returns */ export declare function useSuspenseQuery<I extends Message<I>, O extends Message<O>, SelectOutData = O>(methodSig: MethodUnaryDescriptor<I, O>, input?: PartialMessage<I>, { transport, callOptions, ...queryOptions }?: Omit<CreateSuspenseQueryOptions<I, O, SelectOutData>, "transport"> & { transport?: Transport; }): UseSuspenseQueryResult<SelectOutData, ConnectError>; //# sourceMappingURL=use-query.d.ts.map