W3cubDocs

/Web Extensions

runtime.lastError

This value is used to report an error message from an asynchronous API, when the asynchronous API is given a callback. This is useful for extensions that are using the callback-based version of the WebExtension APIs.

You don't need to check this property if you are using the promise-based version of the APIs: instead, pass an error handler to the promise:

const gettingCookies = browser.cookies.getAll();
gettingCookies.then(onGot, onError);

The runtime.lastError property is set when an asynchronous function has an error condition that it needs to report to its caller.

If you call an asynchronous function that may set lastError, you are expected to check for the error when you handle the result of the function. If lastError has been set and you don't check it within the callback function, then an error will be raised.

Syntax

let myError = browser.runtime.lastError;  // null or Error object

Value

An Error object representing the error. The message property is a string with a human-readable description of the error . If lastError has not been set, the value is null.

Examples

Set a cookie, using a callback to log the new cookie or report an error:

function logCookie(c) {
  if (browser.runtime.lastError) {
    console.error(browser.runtime.lastError);
  } else {
    console.log(c);
  }
}

browser.cookies.set(
  {url: "https://developer.mozilla.org/"},
  logCookie
);

The same, but using a promise to handle the result of setCookie():

function logCookie(c) {
  console.log(c);
}

function logError(e) {
  console.error(e);
}

const setCookie = browser.cookies.set(
  {url: "https://developer.mozilla.org/"}
);

setCookie.then(logCookie, logError);

Note: runtime.lastError is an alias for extension.lastError. They are set together, and checking either one will work.

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
lastError
Yes
lastError is not an Error object. Instead, it is a plain Object with the error text as the string value of the 'message' property.
14
47
?
Yes
lastError is not an Error object. Instead, it is a plain Object with the error text as the string value of the 'message' property.
14
lastError is only set if a callback is used. Promise results that fail will be rejected with an Error object.
?
?
48
?
?
?

Example extensions

Note: 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.

© 2005–2021 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/runtime/lastError