bookmarks.search()

The bookmarks.search() function searches for bookmarks matching the given query.

This function throws an exception if any of the input parameters are invalid or are not of an appropriate type; look in the console for the error message. The exceptions don't have error IDs, and the messages themselves may change, so don't write code that tries to interpret them.

This is an asynchronous function that returns a Promise.

Syntax

var searching = browser.bookmarks.search(
  query                  // string or object
)

Parameters

query
A string or object describing the query to perform.

If query is a string, it consists of zero or more search terms. Search terms are space-delimited and may be enclosed in quotes to allow multiple-word phrases to be searched against. Each search term matches if it matches any substring in the bookmark's URL or title. Matching is case-insensitive. For a bookmark to match the query, all the query's search terms must match.

If query is an object, it has zero or more of the following 3 properties: query, title, and url, which are described below. For a bookmark to match the query, all provided properties terms must match the specified values.

query Optional
A string specifying one or more terms to match against; the format is identical to the string form of the query parameter. If this isn't a string, an exception is thrown.
url Optional
A string which must exactly match the bookmark's URL. Matching is case-insensitive, and trailing slashes are ignored.

If you pass an invalid URL here, the function will throw an exception.

title Optional
A string This must exactly match the bookmark's title. Matching is case-sensitive.

Return value

A Promise that will be fulfilled with an array of bookmarks.BookmarkTreeNode objects, each representing a single matching bookmark. The array is empty if no results were found.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 47.0 No 33

Example

This example logs the IDs of all bookmarks:

function onFulfilled(bookmarkItems) {
  for (item of bookmarkItems) {
    console.log(item.id);
  }
}

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

var searching = browser.bookmarks.search({});

searching.then(onFulfilled, onRejected);

This example looks to see if the currently active tab is bookmarked:

function onFulfilled(bookmarkItems) {
  if (bookmarkItems.length) {
    console.log("active tab is bookmarked");
  } else {
    console.log("active tab is not bookmarked");
  }
}

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

function checkActiveTab(tab) {
  var searching = browser.bookmarks.search({url: tab.url});
  searching.then(onFulfilled, onRejected);
}

browser.browserAction.onClicked.addListener(checkActiveTab);

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, Sheppy, johannh
 Last updated by: wbamberg,