BaseQueryConfig

Defined in: react/src/types.ts:68

Base configuration for query wrappers (shared between regular and suspense).

Extends

• Omit<QueryObserverOptions<QueryFnData<Service, Method, Transform>, ReactorReturnErr<Service, Method, Transform>, Selected, QueryFnData<Service, Method, Transform>, QueryKey>, "queryFn" | "queryKey">

Type Parameters

Service

Service = BaseActor

The actor interface type

Method

Method extends FunctionName<Service> = FunctionName<Service>

The method name on the actor

Transform

Transform extends TransformKey = "candid"

The transformation key (identity, display, etc.)

Selected

Selected = QueryFnData<Service, Method, Transform>

The type returned after select transformation

Properties

functionName

functionName: Method

Defined in: react/src/types.ts:84

The method to call on the canister

---

args?

optional args?: ReactorArgs<Service, Method, Transform>

Defined in: react/src/types.ts:86

Arguments to pass to the method (if any)

---

callConfig?

optional callConfig?: CallConfig

Defined in: react/src/types.ts:105

Call configuration for the method, as Reactor.callMethod takes it: a canisterId sends the query to another canister of the same interface, an agent sends it through another agent, effectiveCanisterId routes it. The query key carries what it sets, as the hooks’ keys do, so the answer is cached apart from the reactor’s own canister and agent, and getQueryKey(), invalidate() and the other cache controls act on that entry.

Example

// The same ledger interface, another token's canister
const ckbtcSymbol = createQuery(ledger, {
  functionName: "icrc1_symbol",
  callConfig: { canisterId: "mxzaz-hqaaa-aaaar-qaada-cai" },
})

---

queryKey?

optional queryKey?: readonly unknown[]

Defined in: react/src/types.ts:107

The query key to use for this query

---

staleTime?

optional staleTime?: number

Defined in: react/src/types.ts:119

How long data stays fresh before refetching, in milliseconds.

createQuery, createSuspenseQuery and their factories default to 5 minutes. The bound useActorQuery and useActorSuspenseQuery hooks (from createActorHooks or defineReactor) set no default and leave it to TanStack Query, which reads the QueryClient’s defaultOptions.queries.staleTime. With that unset too, useActorQuery uses 0 and useActorSuspenseQuery uses 1 second, TanStack Query’s fallback for suspense queries.

Overrides

Omit.staleTime

---

select?

optional select?: (data) => Selected

Defined in: react/src/types.ts:121

Transform the raw result before returning

Parameters

data

ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>

Returns

Selected

Overrides

Omit.select