跳转到主内容

函数:showInputBox()

showInputBox(options?, token?): Promise<undefined | string>

定义于:packages/extension-api/src/extension-api.d.ts:2308

打开一个输入框以请求用户输入。

如果输入框被取消(例如,按 ESC 键),则返回值将为 undefined。否则,返回值将是用户键入的字符串,如果用户没有键入任何内容但按 OK 关闭了输入框,则返回空字符串。

参数

options?

InputBoxOptions

配置输入框的行为。

token?

CancellationToken

一个可用于发出取消信号的 token。

返回

Promise<undefined | string>

一个解析为用户提供的字符串或在取消时为 undefined 的 Promise。