Class AgentResult<T>

Staticsuccess

• success<T>(
      data: T,
      metadata: AgentExecutionMetadata,
      warnings?: string[],
  ): AgentResult<T>

  Creates a successful agent result

  Type Parameters

  • T

  Parameters

  • data: T

    The successful result data
  • metadata: AgentExecutionMetadata

    Execution metadata (model, cost, tokens, etc.)
  • warnings: string[] = []

    Optional warnings to include

  Returns AgentResult<T>

  A successful AgentResult

Staticpartial

• partial<T>(
      data: T,
      metadata: AgentExecutionMetadata,
      warnings: string[],
  ): AgentResult<T>

  Creates a partial result (successful but incomplete)

  Type Parameters

  • T

  Parameters

  • data: T

    The partial result data
  • metadata: AgentExecutionMetadata

    Execution metadata
  • warnings: string[]

    Warnings explaining why result is partial

  Returns AgentResult<T>

  A partial AgentResult

Staticfailure

• failure<T>(
      error: Error,
      metadata: AgentExecutionMetadata,
      partialData?: T,
  ): AgentResult<T>

  Creates a failed agent result

  Type Parameters

  • T

  Parameters

  • error: Error

    The error that occurred
  • metadata: AgentExecutionMetadata

    Execution metadata
  • OptionalpartialData: T

    Optional partial data if some work was completed

  Returns AgentResult<T>

  A failed AgentResult

isSuccess

• isSuccess(): this is AgentResult<T> & { data: T }

  Checks if the result is successful

  Returns this is AgentResult<T> & { data: T }

isFailure

• isFailure(): this is AgentResult<T> & { error: Error }

  Checks if the result is a failure

  Returns this is AgentResult<T> & { error: Error }

hasWarnings

• hasWarnings(): boolean

  Checks if the result has warnings

  Returns boolean

isPartial

• isPartial(): boolean

  Checks if the result is partial

  Returns boolean

unwrap

• unwrap(): T

  Gets the data or throws if the result is a failure

  Returns T

  Throws

  If the result is a failure

unwrapOr

• unwrapOr(defaultValue: T): T

  Gets the data or returns a default value if the result is a failure

  Parameters

  • defaultValue: T

    The default value to return on failure

  Returns T

withTrace

• withTrace(trace: ExecutionTrace): this

  Attaches an execution trace to this result

  Parameters

  • trace: ExecutionTrace

    The execution trace

  Returns this

Readonlysuccess

Readonlydata

Readonlyerror

Readonlymetadata

Readonlywarnings

Readonlypartial

Optionaltrace