tabs.reload()
Reload a tab, optionally bypassing the local web cache.
This is an asynchronous function that returns a Promise
.
Syntax
let reloading = browser.tabs.reload(
tabId, // optional integer
reloadProperties // optional object
)
Parameters
tabId
Optional-
integer
. The ID of the tab to reload. Defaults to the selected tab of the current window. reloadProperties
Optional-
An object with the following properties:
bypassCache
Optional-
boolean
. Bypass the local web cache. Default isfalse
.
Return value
A Promise
that will be fulfilled with no arguments when the tab has been reloaded. If any error occurs, the promise will be rejected with an error message.
Examples
Reload the active tab of the current window:
browser.tabs.reload();
Reload the active tab of the current window, bypassing the cache:
browser.tabs.reload({bypassCache: true});
Reload the tab whose ID is 2, bypassing the cache and calling a callback when done:
function onReloaded() {
console.log(`Reloaded`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
let reloading = browser.tabs.reload(2, {bypassCache: true});
reloading.then(onReloaded, onError);
Example extensions
Browser compatibility
BCD tables only load in the browser
Note: This API is based on Chromium's chrome.tabs
API. This documentation is derived from tabs.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.