@rspc/solid

Public exports of @rspc/solid at version 0.0.0-main-7c0a67c1.

This page documents 0.0.0-main-7c0a67c1. 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;
    Provider: (props: {
        children?: JSX.Element;
        client: {
            _rspc_def: {
                queries: inferProcedures<inferProcedures<TProceduresLike>>["queries"];
                mutations: inferProcedures<inferProcedures<TProceduresLike>>["mutations"];
                subscriptions: inferProcedures<inferProcedures<TProceduresLike>>["subscriptions"];
            };
            query: <K extends inferProcedures<inferProcedures<TProceduresLike>>["queries"]["key"] & string>(keyAndInput: [
                key: K,
                ...input: Extract<inferProcedures<inferProcedures<TProceduresLike>>["queries"], {
                    key: K;
                }>["input"] extends never ? [
                ] : [
                    Extract<inferProcedures<inferProcedures<TProceduresLike>>["queries"], {
                        key: K;
// … truncated, see the source link

View source ↗