@rspc/react

Public exports of @rspc/react at version 0.0.0-main-32fe3d8a.

This page documents 0.0.0-main-32fe3d8a. The documented version is 0.2.2.

InterfacesCopy Anchor Link

BaseOptions

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

View source ↗

Context

interface Context<TProcedures extends ProceduresDef, TQueries extends ProcedureDef, TMutations extends ProcedureDef, TSubscriptions extends ProcedureDef> {
    client: Client<TProcedures, TQueries, TMutations, TSubscriptions>;
    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

createReactHooks

declare function createReactHooks<TBaseProcedures extends ProceduresDef = never, TQueries extends ProcedureDef = TBaseProcedures["queries"], TMutations extends ProcedureDef = TBaseProcedures["mutations"], TSubscriptions extends ProcedureDef = TBaseProcedures["subscriptions"]>(hookOpts?: HookOptions): {
    createClient: (opts: ClientArgs) => {
        _rspc_def: {
            queries: TQueries;
            mutations: TMutations;
            subscriptions: TSubscriptions;
        };
        query: <K extends TQueries["key"] & string>(keyAndInput: [
            key: K,
            ...input: Extract<TQueries, {
                key: K;
            }>["input"] extends null ? [
            ] : [
                Extract<TQueries, {
                    key: K;
                }>["input"]
            ]
        ], opts?: _rspc_client.TRPCRequestOptions | undefined) => Promise<Extract<TQueries, {
            key: K;
        }>["result"]>;
// … truncated, see the source link

View source ↗

internal_createReactHooksFactory

declare function internal_createReactHooksFactory<TBaseProcedures extends ProceduresDef = never, TQueries extends ProcedureDef = TBaseProcedures["queries"], TMutations extends ProcedureDef = TBaseProcedures["mutations"], TSubscriptions extends ProcedureDef = TBaseProcedures["subscriptions"]>(): {
    Provider: ({ children, client, queryClient, }: {
        children?: ReactElement<any, string | react.JSXElementConstructor<any>> | undefined;
        client: {
            _rspc_def: any;
        };
        queryClient: QueryClient;
    }) => JSX.Element;
    createClient: (opts: ClientArgs) => {
        _rspc_def: {
            queries: TQueries;
            mutations: TMutations;
            subscriptions: TSubscriptions;
        };
        query: <K extends TQueries["key"] & string>(keyAndInput: [
            key: K,
            ...input: Extract<TQueries, {
                key: K;
            }>["input"] extends null ? [
            ] : [
                Extract<TQueries, {
// … truncated, see the source link

View source ↗

Re-exportsCopy Anchor Link

internal:__useMutation

useMutation as __useMutation

View source ↗

internal:__useQuery

useQuery as __useQuery

View source ↗