({
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
})
| 1254 | * Convenience wrapper around QueryEngine for one-shot usage. |
| 1255 | */ |
| 1256 | export async function* ask({ |
| 1257 | commands, |
| 1258 | prompt, |
| 1259 | promptUuid, |
| 1260 | isMeta, |
| 1261 | cwd, |
| 1262 | tools, |
| 1263 | mcpClients, |
| 1264 | verbose = false, |
| 1265 | thinkingConfig, |
| 1266 | maxTurns, |
| 1267 | maxBudgetUsd, |
| 1268 | taskBudget, |
| 1269 | canUseTool, |
| 1270 | mutableMessages = [], |
| 1271 | getReadFileCache, |
| 1272 | setReadFileCache, |
| 1273 | customSystemPrompt, |
| 1274 | appendSystemPrompt, |
| 1275 | userSpecifiedModel, |
| 1276 | fallbackModel, |
| 1277 | jsonSchema, |
| 1278 | getAppState, |
| 1279 | setAppState, |
| 1280 | abortController, |
| 1281 | replayUserMessages = false, |
| 1282 | includePartialMessages = false, |
| 1283 | handleElicitation, |
| 1284 | agents = [], |
| 1285 | setSDKStatus, |
| 1286 | orphanedPermission, |
| 1287 | }: { |
| 1288 | commands: Command[] |
| 1289 | prompt: string | Array<ContentBlockParam> |
| 1290 | promptUuid?: string |
| 1291 | isMeta?: boolean |
| 1292 | cwd: string |
| 1293 | tools: Tools |
| 1294 | verbose?: boolean |
| 1295 | mcpClients: MCPServerConnection[] |
| 1296 | thinkingConfig?: ThinkingConfig |
| 1297 | maxTurns?: number |
| 1298 | maxBudgetUsd?: number |
| 1299 | taskBudget?: { total: number } |
| 1300 | canUseTool: CanUseToolFn |
| 1301 | mutableMessages?: Message[] |
| 1302 | customSystemPrompt?: string |
| 1303 | appendSystemPrompt?: string |
| 1304 | userSpecifiedModel?: string |
| 1305 | fallbackModel?: string |
| 1306 | jsonSchema?: Record<string, unknown> |
| 1307 | getAppState: () => AppState |
| 1308 | setAppState: (f: (prev: AppState) => AppState) => void |
| 1309 | getReadFileCache: () => FileStateCache |
| 1310 | setReadFileCache: (cache: FileStateCache) => void |
| 1311 | abortController?: AbortController |
| 1312 | replayUserMessages?: boolean |
| 1313 | includePartialMessages?: boolean |
no test coverage detected