@rspc/solid

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

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

InterfacesCopy Anchor Link

BaseOptions

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

View source ↗

SubscriptionOptions

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

View source ↗

FunctionsCopy Anchor Link

createSolidQueryHooks

export declare function createSolidQueryHooks<TProceduresLike extends ProceduresDef>(): {
    _rspc_def: TProceduresLike;
    createClient: (opts: ClientArgs) => {
        _rspc_def: {
            queries: inferProcedures<TProceduresLike>["queries"];
            mutations: inferProcedures<TProceduresLike>["mutations"];
            subscriptions: inferProcedures<TProceduresLike>["subscriptions"];
        };
        query: <K extends inferProcedures<TProceduresLike>["queries"]["key"] & string>(keyAndInput: [
            key: K,
            ...input: Extract<inferProcedures<TProceduresLike>["queries"], {
                key: K;
            }>["input"] extends null ? [
            ] : [
                Extract<inferProcedures<TProceduresLike>["queries"], {
                    key: K;
                }>["input"]
            ]
        ], opts?: import("@rspc/client").TRPCRequestOptions) => Promise<Extract<inferProcedures<TProceduresLike>["queries"], {
            key: K;
// … truncated, see the source link

View source ↗