Interface UseSharedCallReturnType<A, M>

State for shared calls, including the result, error, and loading status.

interface UseSharedCallReturnType<
    A,
    M extends types.FunctionName<A> = types.FunctionName<A>,
> {
    data: undefined | types.ActorMethodReturnType<A[M]>;
    error: undefined | utils.agent.AgentError;
    loading: boolean;
    isLoading: boolean;
    requestKey: string;
    reset: () => void;
    compileResult: () => types.CompiledResult<
        types.ActorMethodReturnType<A[M]>,
    >;
    call: (
        eventOrReplaceArgs?:
            | types.ActorMethodParameters<A[M]>
            | MouseEvent<Element, MouseEvent>,
    ) => Promise<undefined | types.ActorMethodReturnType<A[M]>>;
}

Type Parameters

A
M extends types.FunctionName<A> = types.FunctionName<A>

Hierarchy (View Summary)

UseSharedCallState<A, M>
- UseSharedCallReturnType
  - UseQueryCallReturnType

Index

Properties

data error loading isLoading requestKey reset compileResult call

Properties

data

data: undefined | types.ActorMethodReturnType<A[M]>

The data returned from the call, or undefined if not yet available.

error

error: undefined | utils.agent.AgentError

The error that occurred during the call, or undefined if none.

loading

loading: boolean

Deprecated

Use isLoading instead. Indicates whether the call is in progress.

isLoading

isLoading: boolean

Indicates whether the call is in progress.

requestKey

requestKey: string

reset

reset: () => void

compileResult

compileResult: () => types.CompiledResult<types.ActorMethodReturnType<A[M]>>

call

call: (
    eventOrReplaceArgs?:
        | types.ActorMethodParameters<A[M]>
        | MouseEvent<Element, MouseEvent>,
) => Promise<undefined | types.ActorMethodReturnType<A[M]>>