ic-reactor
    Preparing search index...

    Interface UseCandidEvaluationReturnType

    interface UseCandidEvaluationReturnType {
        fetchError: null | string;
        fetching: boolean;
        isFetching: boolean;
        validateCandid: (candidString: string) => undefined | boolean;
        isCandidValid: (candidString: string) => undefined | boolean;
        evaluateCandid: (
            candidString: string,
        ) => Promise<undefined | types.IDL.InterfaceFactory>;
    }
    Index

    Properties

    fetchError: null | string

    The error message encountered during the fetch operation, or null if no error occurred.

    fetching: boolean

    Use isFetching instead. Indicates whether a fetch operation is currently in progress.

    isFetching: boolean

    Indicates whether a fetch operation is currently in progress.

    validateCandid: (candidString: string) => undefined | boolean

    Type declaration

      • (candidString: string): undefined | boolean
      • Parameters

        • candidString: string

          The Candid definition to validate.

        Returns undefined | boolean

        true if the string is valid, false otherwise.

    Use isCandidValid instead. Validates the provided Candid interface definition string.

    isCandidValid: (candidString: string) => undefined | boolean

    Validates the provided Candid interface definition string.

    Type declaration

      • (candidString: string): undefined | boolean
      • Parameters

        • candidString: string

          The Candid definition to validate.

        Returns undefined | boolean

        true if valid, false otherwise.

    evaluateCandid: (
        candidString: string,
    ) => Promise<undefined | types.IDL.InterfaceFactory>

    Evaluates the provided Candid interface definition string.

    Type declaration