Back to Content

commands.reset()

files/en-us/mozilla/add-ons/webextensions/api/commands/reset/index.md

latest1.0 KB
Original Source

Resets the given command's description and keyboard shortcut to the values given in the extension's commands manifest.json key.

This effectively undoes any changes made to the command using the {{WEbExtAPIRef("commands.update()")}} function.

Syntax

js-nolint
browser.commands.reset(
  name // string
);

Parameters

  • name
    • : string. Name of the command to reset, as given by the name property of the {{WebExtAPIRef("commands.Command")}} object.

Return value

A Promise that will be fulfilled with no arguments when the shortcut has been reset.

Examples

Resets the command named "my-command" when the user clicks the "reset" button:

js
const commandName = "my-command";

function resetShortcut() {
  browser.commands.reset(commandName);
}

document.querySelector("#reset").addEventListener("click", resetShortcut);

{{WebExtExamples}}

Browser compatibility

{{Compat}}