AgentError interface

Package:: @microsoft/agents-activity

Enhanced error type with additional properties for error code, help link, and inner exception. This interface extends the standard Error type with custom properties added by ExceptionHelper.

Extends: Error

Properties

code	Error code for the exception
description	Human-readable description text for the error (without the bracketed code prefix or trailing help link). Mirrors `AgentErrorDefinition.description`, with any `{param}` placeholders substituted. Use this when emitting an error to a wire format that should not leak the internal error code or help link.
helpLink	Help URL link for the error
innerException	Optional inner exception

Inherited Properties

message
name
stack

Property Details

code

Error code for the exception

code: number

Property Value

number

description

Human-readable description text for the error (without the bracketed code prefix or trailing help link). Mirrors AgentErrorDefinition.description, with any {param} placeholders substituted. Use this when emitting an error to a wire format that should not leak the internal error code or help link.

description: string

Property Value

string

helpLink

Help URL link for the error

helpLink: string

Property Value

string

innerException

Optional inner exception

innerException?: Error

Property Value

Error

Inherited Property Details

message

message: string

Property Value

string

Inherited From Error.message

name

name: string

Property Value

string

Inherited From Error.name

stack

stack?: string

Property Value

string

Inherited From Error.stack