bookmarks.remove()

The bookmarks.remove() method removes a single bookmark or an empty bookmark folder.

Warning: If your extension attempts to remove a bookmark from the bookmarks tree root node, the call will raise an error with the message: "The bookmark root cannot be modified" and the bookmark won't be removed.

This is an asynchronous function that returns a Promise.

Syntax

js
let removingBookmark = browser.bookmarks.remove(
  id                 // string
)

Parameters

id

A string specifying the ID of the bookmark or empty folder to remove.

Return value

A Promise that will be fulfilled with no arguments.

If the node corresponding to the id parameter can't be found or was a non-empty folder, the promise is rejected with an error message.

Examples

js
function onRemoved() {
  console.log("Removed!");
}

function onRejected(error) {
  console.log(`An error: ${error}`);
}

let bookmarkId = "abcdefghijkl";

let removingBookmark = browser.bookmarks.remove(bookmarkId);
removingBookmark.then(onRemoved, onRejected);

Example extensions

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.