UseReactorMethodResult
Defined in: react/src/hooks/useActorMethod.ts:128
Result type for useActorMethod hook. Provides a unified interface for both query and mutation methods.
Type Parameters
Section titled “Type Parameters”Service
Section titled “Service”Service = BaseActor
Method
Section titled “Method”Method extends FunctionName<Service> = FunctionName<Service>
Transform
Section titled “Transform”Transform extends TransformKey = "candid"
Properties
Section titled “Properties”data:
ReactorQueryData<ReactorReturnOk<Service,Method,Transform>> |undefined
Defined in: react/src/hooks/useActorMethod.ts:139
The returned data from the method call. A method’s undefined result is
null here, as in useActorQuery, so undefined means that no call has
settled yet, that the last call failed, or that an update call is
running. A query keeps its earlier data when a refetch fails.
isLoading
Section titled “isLoading”isLoading:
boolean
Defined in: react/src/hooks/useActorMethod.ts:143
Whether the method is currently executing
isPending
Section titled “isPending”isPending:
boolean
Defined in: react/src/hooks/useActorMethod.ts:146
Alias for isLoading - whether a mutation is pending
isError
Section titled “isError”isError:
boolean
Defined in: react/src/hooks/useActorMethod.ts:149
Whether there was an error
isSuccess
Section titled “isSuccess”isSuccess:
boolean
Defined in: react/src/hooks/useActorMethod.ts:152
Whether the method has successfully completed at least once
error:
ReactorReturnErr<Service,Method,Transform> |null
Defined in: react/src/hooks/useActorMethod.ts:155
The error if one occurred
isQuery
Section titled “isQuery”isQuery:
boolean
Defined in: react/src/hooks/useActorMethod.ts:158
Whether this is a query method (true) or mutation method (false)
functionType
Section titled “functionType”functionType:
FunctionType
Defined in: react/src/hooks/useActorMethod.ts:161
The function type (query, update, composite_query)
call: (
args?) =>Promise<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>> |undefined>
Defined in: react/src/hooks/useActorMethod.ts:177
Call the method with optional arguments. For queries: triggers a refetch For mutations: executes the mutation with the provided args
For a query method, call(args) fetches those args from the canister
even when they are cached, and reports the result to onSuccess or
onError itself. call() refetches the hook’s own args, as refetch()
does. Either resolves undefined when its fetch fails. A sign-in or
sign-out while either is in flight cancels the fetch, which then runs
again for the principal signed in, so the call resolves with that
principal’s answer rather than the previous one’s; see
ClientManager.fetchAcrossIdentitySwitch.
Parameters
Section titled “Parameters”ReactorArgs<Service, Method, Transform>
Returns
Section titled “Returns”Promise<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>> | undefined>
reset: () =>
void
Defined in: react/src/hooks/useActorMethod.ts:191
Reset the state (data and error).
For queries: resets this hook’s own cache entry to its initial state, so
data goes back to initialData when one was given and is cleared
otherwise. An enabled hook then refetches. Other args of the same method
are left alone.
For mutations: resets the mutation state
Returns
Section titled “Returns”void
refetch
Section titled “refetch”refetch: () =>
Promise<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>> |undefined>
Defined in: react/src/hooks/useActorMethod.ts:202
For queries only: Refetch the query
Resolves with the answer, or undefined when the refetch fails, whose
error the hook reports to onError; data keeps the last answer. A
sign-in or sign-out while it is in flight makes it refetch for the
principal signed in, and it resolves with that principal’s answer, as
call() does.
Returns
Section titled “Returns”Promise<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>> | undefined>
queryResult?
Section titled “queryResult?”
optionalqueryResult?:UseQueryResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>>
Defined in: react/src/hooks/useActorMethod.ts:208
The raw query result (only available for query methods)
mutationResult?
Section titled “mutationResult?”
optionalmutationResult?:UseMutationResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>,ReactorArgs<Service,Method,Transform>>
Defined in: react/src/hooks/useActorMethod.ts:214
The raw mutation result (only available for mutation methods)