useReactorQuery

useReactorQuery<Service, Method, Transform, Selected>(__namedParameters): UseReactorQueryResult<Service, Method, Transform, Selected>

Defined in: react/src/hooks/useActorQuery.ts:92

Hook for executing query calls on a canister.

Type Parameters

Service

Service

Method

Method extends string

Transform

Transform extends keyof TransformArgsRegistry<unknown> = "candid"

Selected

Selected = ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>

Parameters

__namedParameters

UseReactorQueryParameters<Service, Method, Transform, Selected>

Returns

UseReactorQueryResult<Service, Method, Transform, Selected>

Example

const { data, isLoading } = useReactorQuery({
  reactor,
  functionName: "getUser",
  args: ["user-123"],
})

// With select transformation
const { data } = useReactorQuery({
  reactor,
  functionName: "getUser",
  args: ["user-123"],
  select: (user) => user.name,
})

// Wait for the args: no fetch until userId is known
const { data } = useReactorQuery({
  reactor,
  functionName: "getUser",
  args: userId ? [userId] : skipToken,
})