JavaScript APIs
JavaScript APIs for WebExtensions can be used inside the extension's background scripts and in any other documents bundled with the extension, including browser action or page action popups, sidebars, options pages, or new tab pages. A few of these APIs can also be accessed by an extension's content scripts. (See the list in the content script guide.)
JavaScript APIs for WebExtensions can be used inside the extension's background scripts and in any other documents bundled with the extension, including browser action or page action popups, sidebars, options pages, or new tab pages. A few of these APIs can also be accessed by an extension's content scripts. (See the list in the content script guide.)
To use the more powerful APIs, you need to request permission in your extension's manifest.json.
You can access the APIs using the browser namespace:
function logTabs(tabs) {
console.log(tabs);
}
browser.tabs.query({ currentWindow: true }, logTabs);
Many of the APIs are asynchronous, returning a Promise:
function logCookie(c) {
console.log(c);
}
function logError(e) {
console.error(e);
}
let setCookie = browser.cookies.set({ url: "https://developer.mozilla.org/" });
setCookie.then(logCookie, logError);
Browser namespace differences
Firefox and Safari have always used the browser namespace (with promises). Originally, Chromium-based browsers (such as Chrome, Opera, and Microsoft Edge) used the chrome namespace (with callbacks).
Starting with Chrome 148, Chrome also supports the browser namespace, except in extensions that include a DevTools page. This limitation was removed in Chrome 152 (see Chrome bug 500769389), and the browser namespace became available to all Chrome extensions. Also, Chrome began providing promises for asynchronous methods with the introduction of Manifest V3, with complete coverage delivered in Chrome 152.
This means that all major browsers use the browser namespace and return promises for asynchronous functions.
Before Chrome 148, Chrome uses the chrome namespace. As a porting aid, the Firefox implementation of WebExtensions APIs supports chrome and callbacks as well as browser and Promises. This allows code written for Chrome to run largely unchanged in Firefox for the APIs documented here. A polyfill that enables code that uses browser and promises to work unchanged in Chrome is also available. This polyfill is a no-op in Chrome 148 and later.
Not all browsers support all the APIs: for the details, see Browser support for JavaScript APIs and Chrome incompatibilities.
Examples
Throughout the JavaScript API listings, short code examples illustrate how the API is used. You can experiment with most of these examples using the console in the Toolbox. However, you need Toolbox running in the context of a web extension. To do this, open about:debugging then This Firefox, click Inspect against any installed or temporary extension, and open Console. You can then paste and run the example code in the console.
For example, here is the tabs-tabs-tabs extension running in the Toolbox console in Firefox Developer Edition:

JavaScript API listing
See below for a complete list of JavaScript APIs: