getAll()

Gets all commands for the extension that you have registered using the commands manifest.json key.

The commands are returned as an array of commands.Command objects. Alternately, if you are using the promise-based version of the API, browser.commands.getAll(), the commands are passed into the onFulfilled argument to Promise.then().

This is an asynchronous function that returns a Promise.

Syntax

var getCommands = browser.commands.getAll();

Parameters

None.

Return value

A Promise that will be fulfilled with an array of commands.Command objects, one for each command registered for the extension. If no commands were registered, the array will be empty.

Browser compatibility

BCD tables only load in the browser

Examples

function logCommands(commands) {
  commands.forEach(function(command) {
    console.log(command);
  });
}

var getCommands = browser.commands.getAll();
getCommands.then(logCommands);

Example extensions

Acknowledgements

This API is based on Chromium's chrome.commands API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.