PageSourceSearch

https://trpc.io/assets/js/46c56448.7d1f0fec.js

js trpc.io collected 2026-10-02 02:24:47 UTC 14,821 bytes, 1 lines download raw bytes

1"use strict";(self.webpackChunkwww=self.webpackChunkwww||[]).push([["13716"],{92570(e,r,s){s.r(r),s.d(r,{metadata:()=>n,default:()=>o,frontMatter:()=>t,contentTitle:()=>i,toc:()=>a,assets:()=>l});var n=JSON.parse('{"id":"typedoc/tanstack-react-query/interfaces/TRPCQueryOptions","title":"Interface: TRPCQueryOptions()\\\\<TDef, TFeatureFlags\\\\>","description":"Defined in151","source":"@site/docs/typedoc/tanstack-react-query/interfaces/TRPCQueryOptions.md","sourceDirName":"typedoc/tanstack-react-query/interfaces","slug":"/typedoc/tanstack-react-query/interfaces/TRPCQueryOptions","permalink":"/docs/typedoc/tanstack-react-query/interfaces/TRPCQueryOptions","draft":false,"unlisted":false,"editUrl":"https://github.com/trpc/trpc/tree/main/www/docs/typedoc/tanstack-react-query/interfaces/TRPCQueryOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"Interface: TRPCQueryBaseOptions","permalink":"/docs/typedoc/tanstack-react-query/interfaces/TRPCQueryBaseOptions"},"next":{"title":"Interface: TRPCQueryOptionsResult","permalink":"/docs/typedoc/tanstack-react-query/interfaces/TRPCQueryOptionsResult"}}'),d=s(27968),c=s(77334);let t={},i="Interface: TRPCQueryOptions()<TDef, TFeatureFlags>",l={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Type Parameters",id:"type-parameters-1",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Type Parameters",id:"type-parameters-2",level:2},{value:"Parameters",id:"parameters-1",level:2},{value:"Returns",id:"returns-1",level:2},{value:"Type Parameters",id:"type-parameters-3",level:2},{value:"Parameters",id:"parameters-2",level:2},{value:"Returns",id:"returns-2",level:2}];function h(e){let r={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(r.header,{children:(0,d.jsx)(r.h1,{id:"interface-trpcqueryoptionstdef-tfeatureflags",children:"Interface: TRPCQueryOptions()<TDef, TFeatureFlags>"})}),"\n",(0,d.jsxs)(r.p,{children:["Defined in: ",(0,d.jsx)(r.a,{href:"https://github.com/trpc/trpc/blob/f55eeb408e824a0443a78904644b7a5981644779/packages/tanstack-react-query/src/internals/queryOptions.ts#L151",children:"tanstack-react-query/src/internals/queryOptions.ts:151"})]}),"\n",(0,d.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Type Parameter"}),(0,d.jsx)(r.th,{children:"Default type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TDef"})," ",(0,d.jsx)(r.em,{children:"extends"})," ",(0,d.jsx)(r.code,{children:"ResolverDef"})]}),(0,d.jsx)(r.td,{children:"-"})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TFeatureFlags"})," ",(0,d.jsx)(r.em,{children:"extends"})," ",(0,d.jsx)(r.a,{href:"/docs/typedoc/tanstack-react-query/type-aliases/FeatureFlags",children:(0,d.jsx)(r.code,{children:"FeatureFlags"})})]}),(0,d.jsx)(r.td,{children:(0,d.jsx)(r.a,{href:"/docs/typedoc/tanstack-react-query/type-aliases/DefaultFeatureFlags",children:(0,d.jsx)(r.code,{children:"DefaultFeatureFlags"})})})]})]})]}),"\n",(0,d.jsxs)(r.blockquote,{children:["\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.strong,{children:"TRPCQueryOptions"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),">(",(0,d.jsx)(r.code,{children:"input"}),", ",(0,d.jsx)(r.code,{children:"opts"}),"): ",(0,d.jsx)(r.code,{children:"DefinedTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]}),"\n"]}),"\n",(0,d.jsxs)(r.p,{children:["Defined in: ",(0,d.jsx)(r.a,{href:"https://github.com/trpc/trpc/blob/f55eeb408e824a0443a78904644b7a5981644779/packages/tanstack-react-query/src/internals/queryOptions.ts#L155",children:"tanstack-react-query/src/internals/queryOptions.ts:155"})]}),"\n",(0,d.jsx)(r.h2,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Type Parameter"}),(0,d.jsx)(r.th,{children:"Default type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TQueryFnData"})," ",(0,d.jsx)(r.em,{children:"extends"})," ",(0,d.jsx)(r.code,{children:"any"})]}),(0,d.jsx)(r.td,{children:"-"})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TData"})}),(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TQueryFnData"})})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Parameter"}),(0,d.jsx)(r.th,{children:"Type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"input"})}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"input"'}),"] | ",(0,d.jsx)(r.em,{children:"typeof"})," ",(0,d.jsx)(r.code,{children:"skipToken"})]})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"opts"})}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"DefinedTRPCQueryOptionsIn"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.code,{children:"DefinedTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]}),"\n",(0,d.jsxs)(r.blockquote,{children:["\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.strong,{children:"TRPCQueryOptions"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),">(",(0,d.jsx)(r.code,{children:"input"}),", ",(0,d.jsx)(r.code,{children:"opts"}),"?): ",(0,d.jsx)(r.code,{children:"UnusedSkipTokenTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]}),"\n"]}),"\n",(0,d.jsxs)(r.p,{children:["Defined in: ",(0,d.jsx)(r.a,{href:"https://github.com/trpc/trpc/blob/f55eeb408e824a0443a78904644b7a5981644779/packages/tanstack-react-query/src/internals/queryOptions.ts#L175",children:"tanstack-react-query/src/internals/queryOptions.ts:175"})]}),"\n",(0,d.jsx)(r.h2,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Type Parameter"}),(0,d.jsx)(r.th,{children:"Default type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TQueryFnData"})," ",(0,d.jsx)(r.em,{children:"extends"})," ",(0,d.jsx)(r.code,{children:"any"})]}),(0,d.jsx)(r.td,{children:"-"})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TData"})}),(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TQueryFnData"})})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"parameters-1",children:"Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Parameter"}),(0,d.jsx)(r.th,{children:"Type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"input"})}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"input"'}),"]"]})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"opts"}),"?"]}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"UnusedSkipTokenTRPCQueryOptionsIn"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"returns-1",children:"Returns"}),"\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.code,{children:"UnusedSkipTokenTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]}),"\n",(0,d.jsxs)(r.blockquote,{children:["\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.strong,{children:"TRPCQueryOptions"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),">(",(0,d.jsx)(r.code,{children:"input"}),", ",(0,d.jsx)(r.code,{children:"opts"}
1),"?): ",(0,d.jsx)(r.code,{children:"UndefinedTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]}),"\n"]}),"\n",(0,d.jsxs)(r.p,{children:["Defined in: ",(0,d.jsx)(r.a,{href:"https://github.com/trpc/trpc/blob/f55eeb408e824a0443a78904644b7a5981644779/packages/tanstack-react-query/src/internals/queryOptions.ts#L195",children:"tanstack-react-query/src/internals/queryOptions.ts:195"})]}),"\n",(0,d.jsx)(r.h2,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Type Parameter"}),(0,d.jsx)(r.th,{children:"Default type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TQueryFnData"})," ",(0,d.jsx)(r.em,{children:"extends"})," ",(0,d.jsx)(r.code,{children:"any"})]}),(0,d.jsx)(r.td,{children:"-"})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TData"})}),(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"TQueryFnData"})})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"parameters-2",children:"Parameters"}),"\n",(0,d.jsxs)(r.table,{children:[(0,d.jsx)(r.thead,{children:(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.th,{children:"Parameter"}),(0,d.jsx)(r.th,{children:"Type"})]})}),(0,d.jsxs)(r.tbody,{children:[(0,d.jsxs)(r.tr,{children:[(0,d.jsx)(r.td,{children:(0,d.jsx)(r.code,{children:"input"})}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"input"'}),"] | ",(0,d.jsx)(r.em,{children:"typeof"})," ",(0,d.jsx)(r.code,{children:"skipToken"})]})]}),(0,d.jsxs)(r.tr,{children:[(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"opts"}),"?"]}),(0,d.jsxs)(r.td,{children:[(0,d.jsx)(r.code,{children:"UndefinedTRPCQueryOptionsIn"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]})]})]})]}),"\n",(0,d.jsx)(r.h2,{id:"returns-2",children:"Returns"}),"\n",(0,d.jsxs)(r.p,{children:[(0,d.jsx)(r.code,{children:"UndefinedTRPCQueryOptionsOut"}),"<",(0,d.jsx)(r.code,{children:"TQueryFnData"}),", ",(0,d.jsx)(r.code,{children:"TData"}),", ",(0,d.jsx)(r.code,{children:"TRPCClientErrorLike"}),"<{ ",(0,d.jsx)(r.code,{children:"errorShape"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"errorShape"'}),"]; ",(0,d.jsx)(r.code,{children:"transformer"}),": ",(0,d.jsx)(r.code,{children:"TDef"}),"[",(0,d.jsx)(r.code,{children:'"transformer"'}),"]; }>, ",(0,d.jsx)(r.code,{children:"TFeatureFlags"}),">"]})]})}function o(e={}){let{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,d.jsx)(r,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},77334(e,r,s){s.d(r,{R:()=>t,x:()=>i});var n=s(64700);let d={},c=n.createContext(d);function t(e){let r=n.useContext(c);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]);

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.