@rspc/react

Public exports of @rspc/react at version 0.1.0.

This page documents 0.1.0. The documented version is 0.2.2.

InterfacesCopy Anchor Link

BaseOptions

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

View source ↗

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 ProceduresLike>(): {
    _rspc_def: inferProcedures<TProceduresLike>;
    Provider: ({ children, client, queryClient, }: {
        children?: ReactElement<any, string | react.JSXElementConstructor<any>> | undefined;
        client: Client<inferProcedures<TProceduresLike>>;
        queryClient: QueryClient;
    }) => JSX.Element;
    useContext: () => Context<inferProcedures<TProceduresLike>>;
    useQuery: <K extends inferProcedures<TProceduresLike>["queries"]["key"] & string, TQueryFnData = inferQueryResult<inferProcedures<TProceduresLike>, K>, TData = inferQueryResult<inferProcedures<TProceduresLike>, K>>(keyAndInput: [
        key: K,
        ...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
    ], opts?: (Omit<UseQueryOptions<TQueryFnData, RSPCError, TData, [
        K,
        inferQueryInput<inferProcedures<TProceduresLike>, K>
// … truncated, see the source link

View source ↗