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

let 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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getAll Yes 79 48 ? Yes 14 ? ? No ? 15 ?

Examples

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

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

Example extensions

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

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/getAll