UNPKG

@connectrpc/connect-query

Version:

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

19 lines 1.03 kB
import type { Message, PartialMessage } from "@bufbuild/protobuf"; import type { CallOptions, ConnectError, Transport } from "@connectrpc/connect"; import type { UseMutationOptions as TSUseMutationOptions, UseMutationResult } from "@tanstack/react-query"; import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js"; /** * Options for useQuery */ export type UseMutationOptions<I extends Message<I>, O extends Message<O>, Ctx = unknown> = Omit<TSUseMutationOptions<O, ConnectError, PartialMessage<I>, Ctx>, "mutationFn"> & { transport?: Transport; callOptions?: CallOptions; }; /** * Query the method provided. Maps to useMutation on tanstack/react-query * * @param methodSig * @returns */ export declare function useMutation<I extends Message<I>, O extends Message<O>, Ctx = unknown>(methodSig: MethodUnaryDescriptor<I, O>, { transport, callOptions, ...queryOptions }?: UseMutationOptions<I, O, Ctx>): UseMutationResult<O, ConnectError, PartialMessage<I>, Ctx>; //# sourceMappingURL=use-mutation.d.ts.map