RspcTypescript apiTs rspc query core
@rspc/query-core
TypeScript API reference for @rspc/query-core, version 0.2.2.
Generated from the published type declarations for this exact release.
Public exports of @rspc/query-core at version 0.2.2.
This page documents 0.2.2. The documented version is 0.3.1.
Interfaces
BaseOptions
interface BaseOptions<TProcedures extends ProceduresDef> {
rspc?: {
client?: Client<TProcedures>;
};
}
Functions
createRSPCQueryUtils
declare function createRSPCQueryUtils<TProceduresLike extends ProceduresDef>(client: Client<inferProcedures<TProceduresLike>>, queryClient: QueryClient): {
fetch: <K extends inferProcedures<TProceduresLike>["queries"]["key"]>(queryKey: [
key: K,
...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
], opts?: Omit<FetchQueryOptions<inferQueryResult<inferProcedures<TProceduresLike>, K>, RSPCError, inferQueryResult<inferProcedures<TProceduresLike>, K>, [
key: K,
...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
], never>, "queryKey" | "queryFn"> & BaseOptions<inferProcedures<TProceduresLike>>) => Promise<unknown>;
prefetch: <K extends inferProcedures<TProceduresLike>["queries"]["key"]>(queryKey: [
key: K,
...input: _inferProcedureHandlerInput<inferProcedures<TProceduresLike>, "queries", K>
// … truncated, see the source link