@rspc/react

Public exports of @rspc/react at version 1.0.0-rc.1.

This page documents 1.0.0-rc.1. The documented version is 0.2.2.

InterfacesCopy Anchor Link

BaseOptions

interface BaseOptions<TProcedures extends ProceduresDef> {
    rspc?: {
        client?: AlphaClient<TProcedures>;
    };
}

View source ↗

Context

interface Context<TProcedures extends ProceduresDef> {
    client: AlphaClient<TProcedures>;
    queryClient: QueryClient;
}

View source ↗

SubscriptionOptions

interface SubscriptionOptions<TOutput> {
    enabled?: boolean;
    onStarted?: () => void;
    onData: (data: TOutput) => void;
    onError?: (err: RSPCError | Error) => void;
}

View source ↗

Type aliasesCopy Anchor Link

HooksOpts

type HooksOpts<P extends ProceduresDef> = {
    context: React.Context<Context<P>>;
};

View source ↗

FunctionsCopy Anchor Link

createReactQueryHooks

declare function createReactQueryHooks<P extends ProceduresDef>(client: AlphaClient<P>, opts?: HooksOpts<P>): {
    _rspc_def: P;
    Provider: ({ children, client, queryClient, }: {
        children?: ReactElement<any, string | react.JSXElementConstructor<any>> | undefined;
        client: AlphaClient<P>;
        queryClient: QueryClient;
    }) => react_jsx_runtime.JSX.Element;
    useContext: () => Context<P>;
    useQuery: <K extends P["queries"]["key"] & string, TQueryFnData = inferQueryResult<P, K>, TData = inferQueryResult<P, K>>(keyAndInput: [
        key: K,
        ...input: _inferProcedureHandlerInput<P, "queries", K>
    ], opts?: (Omit<UseQueryOptions<TQueryFnData, RSPCError, TData, [
        K,
        inferQueryInput<P, K>
    ]>, "queryKey" | "queryFn"> & BaseOptions<P>) | undefined) => UseQueryResult<TData, RSPCError>;
    useMutation: <K_1 extends P["mutations"]["key"] & string, TContext = unknown>(key: K_1 | [
        K_1
// … truncated, see the source link

View source ↗

Re-exportsCopy Anchor Link

QueryClient

QueryClient

View source ↗

QueryClientProvider

QueryClientProvider

View source ↗