mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-17 08:00:59 +00:00
Remove unnecessary comments from types
This commit is contained in:
parent
a433e524a0
commit
5c37fe27c6
2 changed files with 0 additions and 46 deletions
|
|
@ -36,27 +36,6 @@ export interface CustomToolAPI {
|
||||||
hasUI: boolean;
|
hasUI: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Clawd here, summarizing what's available to custom tools:
|
|
||||||
*
|
|
||||||
* CustomToolAPI (passed to factory, stable across session changes):
|
|
||||||
* - cwd: string - current working directory
|
|
||||||
* - exec(cmd, args, options?): Promise<ExecResult> - run shell commands
|
|
||||||
* - ui: CustomToolUIContext - select, confirm, input, notify, custom, setStatus, theme
|
|
||||||
* - hasUI: boolean - false in print/RPC mode
|
|
||||||
*
|
|
||||||
* CustomToolContext (passed to execute and onSession):
|
|
||||||
* - sessionManager: ReadonlySessionManager - read session entries, branch info
|
|
||||||
* - modelRegistry: ModelRegistry - get API keys, list models
|
|
||||||
* - model: Model | undefined - current model
|
|
||||||
* - isIdle(): boolean - check if agent is streaming
|
|
||||||
* - hasQueuedMessages(): boolean - check if user queued input (skip interactive prompts!)
|
|
||||||
* - abort(): void - fire-and-forget abort (sets signal, doesn't wait)
|
|
||||||
*
|
|
||||||
* Note: Custom tools run inside the agent loop (like tool_call events in hooks),
|
|
||||||
* so they only get the safe read-only methods. No waitForIdle/newSession/branch/navigateTree.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Context passed to tool execute and onSession callbacks.
|
* Context passed to tool execute and onSession callbacks.
|
||||||
* Provides access to session state and model information.
|
* Provides access to session state and model information.
|
||||||
|
|
|
||||||
|
|
@ -130,31 +130,6 @@ export interface HookUIContext {
|
||||||
readonly theme: Theme;
|
readonly theme: Theme;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Clawd here, summarizing what's available to hooks:
|
|
||||||
*
|
|
||||||
* HookContext (available in ALL event handlers):
|
|
||||||
* - ui: HookUIContext - select, confirm, input, notify, custom, setStatus, theme
|
|
||||||
* - hasUI: boolean - false in print/RPC mode
|
|
||||||
* - cwd: string - current working directory
|
|
||||||
* - sessionManager: ReadonlySessionManager - read session entries, branch info
|
|
||||||
* - modelRegistry: ModelRegistry - get API keys, list models
|
|
||||||
* - model: Model | undefined - current model
|
|
||||||
* - isIdle(): boolean - check if agent is streaming
|
|
||||||
* - hasQueuedMessages(): boolean - check if user queued input (skip interactive prompts)
|
|
||||||
* - abort(): void - fire-and-forget abort (sets signal, doesn't wait)
|
|
||||||
*
|
|
||||||
* HookCommandContext (only in registerCommand handlers, extends HookContext):
|
|
||||||
* - waitForIdle(): Promise<void> - wait for agent to finish
|
|
||||||
* - newSession(options?): Promise - create new session with optional setup
|
|
||||||
* - branch(entryId): Promise - branch from specific entry
|
|
||||||
* - navigateTree(targetId, options?): Promise - navigate session tree
|
|
||||||
*
|
|
||||||
* Why the split? Session control methods (waitForIdle, newSession, etc.) would DEADLOCK
|
|
||||||
* if called from event handlers like tool_call or context, because those run inside
|
|
||||||
* the agent loop. Slash commands run from user input, outside the loop, so they're safe.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Context passed to hook event handlers.
|
* Context passed to hook event handlers.
|
||||||
* For command handlers, see HookCommandContext which extends this with session control methods.
|
* For command handlers, see HookCommandContext which extends this with session control methods.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue