Specta LogoSpecta
RspcTypescript apiTs rspc react query

@rspc/react-query

TypeScript API reference for @rspc/react-query, version 0.0.0-main-a5d698cd.

Generated from the published type declarations for this exact release.

Public exports of @rspc/react-query at version 0.0.0-main-a5d698cd.

This page documents 0.0.0-main-a5d698cd. The documented version is 0.3.1.

Functions

createReactQueryHooks

export declare function createReactQueryHooks<P extends rspc.ProceduresDef>(): {
    _rspc_def: P;
    Provider: ({ children, client, queryClient, }: React.PropsWithChildren<rspc.Context<P>>) => import("react/jsx-runtime").JSX.Element;
    useContext: () => rspc.Context<P>;
    useQuery: <K extends rspc.inferQueries<P>["key"] & string>(keyAndInput: [
        key: K,
        ...input: rspc._inferProcedureHandlerInput<P, "queries", K>
    ], opts?: rspc.HookOptions<P, rspc.QueryOptionsOmit<tanstack.UseQueryOptions<rspc.inferQueryResult<P, K>, rspc.inferQueryError<P, K>, rspc.inferQueryResult<P, K>, [
        K,
        rspc.inferQueryInput<P, K>
    ]>>> | undefined) => tanstack.UseQueryResult<rspc.inferQueryResult<P, K>, rspc.inferQueryError<P, K>>;
    useMutation: <K_1 extends rspc.inferMutations<P>["key"] & string, TContext = unknown>(key: K_1 | [
        K_1
// … truncated, see the source link

View source ↗

On this page