({
commands,
prompt,
promptUuid,
isMeta,
cwd,
tools,
mcpClients,
verbose = false,
thinkingConfig,
maxTurns,
maxBudgetUsd,
taskBudget,
canUseTool,
mutableMessages = [],
getReadFileCache,
setReadFileCache,
customSystemPrompt,
appendSystemPrompt,
userSpecifiedModel,
fallbackModel,
jsonSchema,
getAppState,
setAppState,
abortController,
replayUserMessages = false,
includePartialMessages = false,
handleElicitation,
agents = [],
setSDKStatus,
orphanedPermission,
}: {
commands: Command[]
prompt: string | Array<ContentBlockParam>
promptUuid?: string
isMeta?: boolean
cwd: string
tools: Tools
verbose?: boolean
mcpClients: MCPServerConnection[]
thinkingConfig?: ThinkingConfig
maxTurns?: number
maxBudgetUsd?: number
taskBudget?: { total: number }
canUseTool: CanUseToolFn
mutableMessages?: Message[]
customSystemPrompt?: string
appendSystemPrompt?: string
userSpecifiedModel?: string
fallbackModel?: string
jsonSchema?: Record<string, unknown>
getAppState: () => AppState
setAppState: (f: (prev: AppState) => AppState) => void
getReadFileCache: () => FileStateCache
setReadFileCache: (cache: FileStateCache) => void
abortController?: AbortController
replayUserMessages?: boolean
includePartialMessages?: boolean
handleElicitation?: ToolUseContext['handleElicitation']
agents?: AgentDefinition[]
setSDKStatus?: (status: SDKStatus) => void
orphanedPermission?: OrphanedPermission
})
| 1186 | * Convenience wrapper around QueryEngine for one-shot usage. |
| 1187 | */ |
| 1188 | export async function* ask({ |
| 1189 | commands, |
| 1190 | prompt, |
| 1191 | promptUuid, |
| 1192 | isMeta, |
| 1193 | cwd, |
| 1194 | tools, |
| 1195 | mcpClients, |
| 1196 | verbose = false, |
| 1197 | thinkingConfig, |
| 1198 | maxTurns, |
| 1199 | maxBudgetUsd, |
| 1200 | taskBudget, |
| 1201 | canUseTool, |
| 1202 | mutableMessages = [], |
| 1203 | getReadFileCache, |
| 1204 | setReadFileCache, |
| 1205 | customSystemPrompt, |
| 1206 | appendSystemPrompt, |
| 1207 | userSpecifiedModel, |
| 1208 | fallbackModel, |
| 1209 | jsonSchema, |
| 1210 | getAppState, |
| 1211 | setAppState, |
| 1212 | abortController, |
| 1213 | replayUserMessages = false, |
| 1214 | includePartialMessages = false, |
| 1215 | handleElicitation, |
| 1216 | agents = [], |
| 1217 | setSDKStatus, |
| 1218 | orphanedPermission, |
| 1219 | }: { |
| 1220 | commands: Command[] |
| 1221 | prompt: string | Array<ContentBlockParam> |
| 1222 | promptUuid?: string |
| 1223 | isMeta?: boolean |
| 1224 | cwd: string |
| 1225 | tools: Tools |
| 1226 | verbose?: boolean |
| 1227 | mcpClients: MCPServerConnection[] |
| 1228 | thinkingConfig?: ThinkingConfig |
| 1229 | maxTurns?: number |
| 1230 | maxBudgetUsd?: number |
| 1231 | taskBudget?: { total: number } |
| 1232 | canUseTool: CanUseToolFn |
| 1233 | mutableMessages?: Message[] |
| 1234 | customSystemPrompt?: string |
| 1235 | appendSystemPrompt?: string |
| 1236 | userSpecifiedModel?: string |
| 1237 | fallbackModel?: string |
| 1238 | jsonSchema?: Record<string, unknown> |
| 1239 | getAppState: () => AppState |
| 1240 | setAppState: (f: (prev: AppState) => AppState) => void |
| 1241 | getReadFileCache: () => FileStateCache |
| 1242 | setReadFileCache: (cache: FileStateCache) => void |
| 1243 | abortController?: AbortController |
| 1244 | replayUserMessages?: boolean |
| 1245 | includePartialMessages?: boolean |
no test coverage detected