@rspc/solid

Public exports of @rspc/solid at version 0.1.2.

This page documents 0.1.2. 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: Client<inferProcedures<TProceduresLike>>;
        queryClient: QueryClient;
    }) => JSX.Element;
    useContext: () => Context<inferProcedures<TProceduresLike>>;
    createQuery: <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<CreateQueryOptions<TQueryFnData, RSPCError, TData, () => [
        K,
        inferQueryInput<inferProcedures<TProceduresLike>, K>
    ]>, "queryFn" | "queryKey"> & BaseOptions<inferProcedures<TProceduresLike>>) => CreateQueryResult<TData, RSPCError>;
// … truncated, see the source link

View source ↗