@rspc/react

Public exports of @rspc/react at version 0.1.2.

This page documents 0.1.2. 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>>;
    customQuery: <TConstrainedProcedures extends ProcedureDef>(map: (key: [
        key: TConstrainedProcedures["key"],
        ...input: TConstrainedProcedures["input"]
    ]) => [
        inferProcedures<TProceduresLike>["queries"]["key"] & string,
        inferProcedures<TProceduresLike>["queries"]["input"]
    ]) => <K extends TConstrainedProcedures["key"] & string, TQueryFnData = Extract<TConstrainedProcedures, {
        key: K;
    }>["result"], TData = Extract<TConstrainedProcedures, {
        key: K;
// … truncated, see the source link

View source ↗