Type Alias: ToolResult<T>

Makaio Framework

---

Makaio Framework / tools-core / ToolResult

Type Alias: ToolResult<T>

ToolResult<T> = ToolSuccess<T> | ToolFailure

Defined in: ../../../tools/core/src/types.ts:134

Discriminated union result type for tool executions. Always returns either success with data or failure with error.

Type Parameters

T

T

Type of the success data

Example

const result: ToolResult<string> = await tool.execute(input, context);
if (result.success) {
  console.debug(result.data); // string
} else {
  console.error(result.error.message);
}

Type Composition

• ToolResult
  • ToolSuccess<T> | ToolFailure
    • ToolSuccess<T>
      • T
      • { success: true; data: T }
    • ToolFailure
      • { success: false; error: ToolError }

Resolved Shape

type ToolResult = {
  success: boolean;
};