commands.update()

更改给定命令的描述或键盘快捷键。

这是一个异步函数,它返回一个 Promise

语法

js
browser.commands.update(
  details // object
);

参数

详细信息

object。具有以下属性的对象

名称

string。要更新的命令的名称。这必须与现有命令的名称匹配,例如在 commands.Command 对象的 name 属性中给出的名称。

description 可选

string。要为命令设置的新描述。

shortcut 可选

string。要为命令设置的新快捷键。这可以是

  • 空字符串以清除快捷键。
  • commands 清单 json 键 的格式匹配的字符串,以设置新的快捷键。如果字符串与该格式不匹配,则该函数会抛出错误。

返回值

一个 Promise,当快捷键更新后,它将使用无参数来实现。如果找不到命令,则该 promise 将使用错误来拒绝。

浏览器兼容性

BCD 表格仅在浏览器中加载

示例

当用户点击“更新”时,使用给定的快捷键值更新名为“my-command”的命令

js
const commandName = "my-command";

function updateShortcut() {
  browser.commands.update({
    name: commandName,
    shortcut: document.querySelector("#shortcut").value,
  });
}

document.querySelector("#update").addEventListener("click", updateShortcut);

示例扩展