Checks to see if an update for the extension is available.
This is an asynchronous function that returns a Promise
.
Syntax
var requestingCheck = browser.runtime.requestUpdateCheck()
Parameters
None.
Return value
A Promise
that will be fulfilled with two arguments:
status
- A
runtime.RequestUpdateCheckStatus
value — the result of the update check. details
Optionalobject
. Ifstatus
isupdate_available
, this contains more information about the update. It is an object containing a single property:-
version
string
. The update's version.
Browser compatibility
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
Request an update, and log the new version if one is available:
function onRequested(status, details) {
console.log(status);
if (status === "update_available") {
console.log(details.version);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
var requestingCheck = browser.runtime.requestUpdateCheck(onRequested);
requestingCheck.then(onRequested, onError);
Acknowledgements
This API is based on Chromium's chrome.runtime
API. This documentation is derived from runtime.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.