bookmarks.getTree()
bookmarks.getTree()
returns an array containing the root of the bookmarks tree as a bookmarks.BookmarkTreeNode
object.
You can access the entire tree recursively using its children
property and the children
property of its descendants, if they are themselves folders.
This is an asynchronous function that returns a Promise
.
Syntax
js
let gettingTree = browser.bookmarks.getTree()
Parameters
None.
Return value
A Promise
that will be fulfilled with an array containing one object, a bookmarks.BookmarkTreeNode
object representing the root node.
Examples
This example prints out the entire bookmarks tree:
js
function makeIndent(indentLength) {
return ".".repeat(indentLength);
}
function logItems(bookmarkItem, indent) {
if (bookmarkItem.url) {
console.log(makeIndent(indent) + bookmarkItem.url);
} else {
console.log(`${makeIndent(indent)}Folder`);
indent++;
}
if (bookmarkItem.children) {
for (const child of bookmarkItem.children) {
logItems(child, indent);
}
}
indent--;
}
function logTree(bookmarkItems) {
logItems(bookmarkItems[0], 0);
}
function onRejected(error) {
console.log(`An error: ${error}`);
}
let gettingTree = browser.bookmarks.getTree();
gettingTree.then(logTree, onRejected);
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.