🚀IC Reactor v3 is here! Featuring TanStack Query integration, improved type safety, and more. View v3 Documentation →
ic-reactor
    Preparing search index...

    Type Alias ActorGetStateFunction<A, M>

    ActorGetStateFunction: {
        (key: "data"): types.ActorMethodReturnType<A[M]>;
        (key: "loading"): boolean;
        (key: "error"): undefined | Error;
        (): {
            data: types.ActorMethodReturnType<A[M]>
            | undefined;
            loading: boolean;
            isLoading: boolean;
            error: utils.agent.AgentError | undefined;
        };
    }

    Type Parameters

    Type declaration

      • (key: "data"): types.ActorMethodReturnType<A[M]>
      • Parameters

        • key: "data"

        Returns types.ActorMethodReturnType<A[M]>

      • (key: "loading"): boolean
      • Parameters

        • key: "loading"

        Returns boolean

      • (key: "error"): undefined | Error
      • Parameters

        • key: "error"

        Returns undefined | Error

      • (): {
            data: types.ActorMethodReturnType<A[M]>
            | undefined;
            loading: boolean;
            isLoading: boolean;
            error: utils.agent.AgentError | undefined;
        }
      • Returns {
            data: types.ActorMethodReturnType<A[M]> | undefined;
            loading: boolean;
            isLoading: boolean;
            error: utils.agent.AgentError | undefined;
        }

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

          The data returned from the actor method call, if available.

        • loading: boolean

          Use isLoading instead. Flag indicating whether the actor method is in progress.

        • isLoading: boolean

          Flag indicating whether the actor method is in progress.

        • error: utils.agent.AgentError | undefined

          Error thrown during the actor method invocation, if any.