@rspc/react

Public exports of @rspc/react at version 0.2.2.

InterfacesCopy Anchor Link

Context

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

View source ↗

SubscriptionOptions

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

View source ↗

FunctionsCopy Anchor Link

createReactQueryHooks

declare function createReactQueryHooks<TProceduresLike extends ProceduresDef>(): {
    _rspc_def: inferProcedures<TProceduresLike>;
    Provider: ({ children, client, queryClient, }: {
        children?: ReactElement;
        client: Client<inferProcedures<TProceduresLike>>;
        queryClient: QueryClient;
    }) => react_jsx_runtime.JSX.Element;
    useContext: () => Context<inferProcedures<TProceduresLike>>;
    useUtils: () => {
        fetch: <K extends inferProcedures<TProceduresLike>["queries"]["key"]>(queryKey: [
            key: K,
            ...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
        ], opts?: (Omit<_tanstack_react_query.FetchQueryOptions<inferQueryResult<inferProcedures<TProceduresLike>, K>, RSPCError, inferQueryResult<inferProcedures<TProceduresLike>, K>, [
            key: K,
            ...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
// … truncated, see the source link

View source ↗

Re-exportsCopy Anchor Link

BaseOptions

BaseOptions

View source ↗