ActorHooks
ActorHooks<
Service,Transform> =object
Defined in: react/src/createActorHooks.ts:55
Type Parameters
Section titled “Type Parameters”Service
Section titled “Service”Service
Transform
Section titled “Transform”Transform extends TransformKey
Properties
Section titled “Properties”useActorQuery
Section titled “useActorQuery”useActorQuery: {<
Method>(config):UseQueryResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>>; <Method,TData>(config):UseQueryResult<TData,ReactorReturnErr<Service,Method,Transform>>; }
Defined in: react/src/createActorHooks.ts:57
Call Signature
Section titled “Call Signature”<
Method>(config):UseQueryResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>>
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends string
Parameters
Section titled “Parameters”config
Section titled “config”SkippableQueryConfig<Service, Method, Transform, ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>>
Returns
Section titled “Returns”UseQueryResult<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, ReactorReturnErr<Service, Method, Transform>>
Call Signature
Section titled “Call Signature”<
Method,TData>(config):UseQueryResult<TData,ReactorReturnErr<Service,Method,Transform>>
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends string
TData
Parameters
Section titled “Parameters”config
Section titled “config”SkippableQueryConfig<Service, Method, Transform, TData>
Returns
Section titled “Returns”UseQueryResult<TData, ReactorReturnErr<Service, Method, Transform>>
useActorSuspenseQuery
Section titled “useActorSuspenseQuery”useActorSuspenseQuery: {<
Method>(config):UseSuspenseQueryResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>>; <Method,TData>(config):UseSuspenseQueryResult<TData,ReactorReturnErr<Service,Method,Transform>>; }
Defined in: react/src/createActorHooks.ts:74
Call Signature
Section titled “Call Signature”<
Method>(config):UseSuspenseQueryResult<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>>
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends string
Parameters
Section titled “Parameters”config
Section titled “config”SuspenseQueryConfig<Service, Method, Transform, ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>>
Returns
Section titled “Returns”UseSuspenseQueryResult<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, ReactorReturnErr<Service, Method, Transform>>
Call Signature
Section titled “Call Signature”<
Method,TData>(config):UseSuspenseQueryResult<TData,ReactorReturnErr<Service,Method,Transform>>
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends string
TData
Parameters
Section titled “Parameters”config
Section titled “config”SuspenseQueryConfig<Service, Method, Transform, TData>
Returns
Section titled “Returns”UseSuspenseQueryResult<TData, ReactorReturnErr<Service, Method, Transform>>
useActorInfiniteQuery
Section titled “useActorInfiniteQuery”useActorInfiniteQuery: <
Method,TPageParam,Selected>(config) =>UseInfiniteQueryResult<Selected,ReactorReturnErr<Service,Method,Transform>>
Defined in: react/src/createActorHooks.ts:96
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends FunctionName<Service>
TPageParam
Section titled “TPageParam”TPageParam = unknown
Selected
Section titled “Selected”Selected = InfiniteData<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, TPageParam>
Parameters
Section titled “Parameters”config
Section titled “config”SkippableInfiniteQueryConfig<Service, Method, Transform, TPageParam, Selected>
Returns
Section titled “Returns”UseInfiniteQueryResult<Selected, ReactorReturnErr<Service, Method, Transform>>
useActorSuspenseInfiniteQuery
Section titled “useActorSuspenseInfiniteQuery”useActorSuspenseInfiniteQuery: <
Method,TPageParam,Selected>(config) =>UseSuspenseInfiniteQueryResult<Selected,ReactorReturnErr<Service,Method,Transform>>
Defined in: react/src/createActorHooks.ts:116
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends FunctionName<Service>
TPageParam
Section titled “TPageParam”TPageParam = unknown
Selected
Section titled “Selected”Selected = InfiniteData<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, TPageParam>
Parameters
Section titled “Parameters”config
Section titled “config”SuspenseInfiniteQueryConfig<Service, Method, Transform, TPageParam, Selected>
Returns
Section titled “Returns”UseSuspenseInfiniteQueryResult<Selected, ReactorReturnErr<Service, Method, Transform>>
useActorMutation
Section titled “useActorMutation”useActorMutation: <
Method,TOnMutateResult>(config) =>UseMutationResult<ReactorReturnOk<Service,Method,Transform>,ReactorReturnErr<Service,Method,Transform>,ReactorArgs<Service,Method,Transform>,TOnMutateResult>
Defined in: react/src/createActorHooks.ts:136
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends FunctionName<Service>
TOnMutateResult
Section titled “TOnMutateResult”TOnMutateResult = unknown
Parameters
Section titled “Parameters”config
Section titled “config”MutationConfig<Service, Method, Transform, TOnMutateResult>
Returns
Section titled “Returns”UseMutationResult<ReactorReturnOk<Service, Method, Transform>, ReactorReturnErr<Service, Method, Transform>, ReactorArgs<Service, Method, Transform>, TOnMutateResult>
useActorMethod
Section titled “useActorMethod”useActorMethod: <
Method>(config) =>ReturnType<typeofuseActorMethod>
Defined in: react/src/createActorHooks.ts:150
Type Parameters
Section titled “Type Parameters”Method
Section titled “Method”Method extends FunctionName<Service>
Parameters
Section titled “Parameters”config
Section titled “config”Omit<UseReactorMethodParameters<Service, Method, Transform>, "reactor">
Returns
Section titled “Returns”ReturnType<typeof useActorMethod>