Class: HooksManager

Defined in: hooks/manager.ts:53

Manages lifecycle hooks for agent customization

Constructors

Constructor

new HooksManager(options?): HooksManager;

Defined in: hooks/manager.ts:65

Parameters

Parameter Type
options HooksManagerOptions

Returns

HooksManager

Methods

clear()

clear(): void;

Defined in: hooks/manager.ts:295

Clear all hooks

Returns

void

getHookCounts()

getHookCounts(): Record<keyof HooksConfig, number>;

Defined in: hooks/manager.ts:664

Get hook counts by type

Returns

Record<keyof HooksConfig, number>

getHookIds()

getHookIds(): string[];

Defined in: hooks/manager.ts:679

Get all registered hook IDs

Returns

string[]

hasHooks()

hasHooks(): boolean;

Defined in: hooks/manager.ts:649

Check if any hooks are registered

Returns

boolean

registerAfterIteration()

registerAfterIteration(hook, options?): string;

Defined in: hooks/manager.ts:143

Register an after:iteration hook

Parameters

Parameter Type
hook AfterIterationHook
options? HookRegistrationOptions

Returns

string

registerAfterLLM()

registerAfterLLM(hook, options?): string;

Defined in: hooks/manager.ts:185

Register an after:llm hook

Parameters

Parameter Type
hook AfterLLMHook
options? HookRegistrationOptions

Returns

string

registerAfterTool()

registerAfterTool(hook, options?): string;

Defined in: hooks/manager.ts:227

Register an after:tool hook

Parameters

Parameter Type
hook AfterToolHook
options? HookRegistrationOptions

Returns

string

registerBeforeIteration()

registerBeforeIteration(hook, options?): string;

Defined in: hooks/manager.ts:122

Register a before:iteration hook

Parameters

Parameter Type
hook BeforeIterationHook
options? HookRegistrationOptions

Returns

string

registerBeforeLLM()

registerBeforeLLM(hook, options?): string;

Defined in: hooks/manager.ts:164

Register a before:llm hook

Parameters

Parameter Type
hook BeforeLLMHook
options? HookRegistrationOptions

Returns

string

registerBeforeTool()

registerBeforeTool(hook, options?): string;

Defined in: hooks/manager.ts:206

Register a before:tool hook

Parameters

Parameter Type
hook BeforeToolHook
options? HookRegistrationOptions

Returns

string

registerFromConfig()

registerFromConfig(config): void;

Defined in: hooks/manager.ts:81

Register hooks from a configuration object

Parameters

Parameter Type
config HooksConfig

Returns

void

registerOnError()

registerOnError(hook, options?): string;

Defined in: hooks/manager.ts:248

Register an onError hook

Parameters

Parameter Type
hook OnErrorHook
options? HookRegistrationOptions

Returns

string

runAfterIteration()

runAfterIteration(context): Promise<void>;

Defined in: hooks/manager.ts:355

Run after:iteration hooks

Parameters

Parameter Type
context IterationHookContext & { completedWithText: boolean; toolCalls: { input: Record<string, unknown>; name: string; result: ToolExecutionResult; }[]; }

Returns

Promise<void>

runAfterLLM()

runAfterLLM(context): Promise<void>;

Defined in: hooks/manager.ts:451

Run after:llm hooks

Parameters

Parameter Type
context AfterLLMHookContext

Returns

Promise<void>

runAfterTool()

runAfterTool(context): Promise<ToolExecutionResult>;

Defined in: hooks/manager.ts:545

Run after:tool hooks

Parameters

Parameter Type
context AfterToolHookContext

Returns

Promise<ToolExecutionResult>

potentially modified result

runBeforeIteration()

runBeforeIteration(context): Promise<boolean>;

Defined in: hooks/manager.ts:314

Run before:iteration hooks

Parameters

Parameter Type
context IterationHookContext

Returns

Promise<boolean>

true to continue, false to skip iteration

runBeforeLLM()

runBeforeLLM(context): Promise<{
  messages: Message[];
  systemPrompt: string;
  tools: ToolDefinition[];
}>;

Defined in: hooks/manager.ts:401

Run before:llm hooks

Parameters

Parameter Type
context LLMHookContext

Returns

Promise<{ messages: Message[]; systemPrompt: string; tools: ToolDefinition[]; }>

potentially modified messages and tools

runBeforeTool()

runBeforeTool(context): Promise<{
  input: Record<string, unknown>;
  proceed: boolean;
  skipResult?: ToolExecutionResult;
}>;

Defined in: hooks/manager.ts:488

Run before:tool hooks

Parameters

Parameter Type
context ToolHookContext

Returns

Promise<{ input: Record<string, unknown>; proceed: boolean; skipResult?: ToolExecutionResult; }>

whether to proceed and potentially modified input or skip result

runOnError()

runOnError(context): Promise<ErrorHookResult>;

Defined in: hooks/manager.ts:591

Run onError hooks

Parameters

Parameter Type
context ErrorHookContext

Returns

Promise<ErrorHookResult>

error handling result

unregister()

unregister(hookId): boolean;

Defined in: hooks/manager.ts:269

Unregister a hook by ID

Parameters

Parameter Type
hookId string

Returns

boolean