Spec-Zone.ru › Web Extensions

history.search()

Ищет в истории браузера объекты history.HistoryItem, соответствующие заданным критериям.

Это асинхронная функция, которая возвращает Promise.

Синтаксис

let searching = browser.history.search(
  query                  // object
)

Параметры

query

Объект, указывающий, что искать в истории браузера. Этот объект имеет следующие поля:

text

string. Поиск элементов истории по URL и заголовку. Строка разбивается на отдельные поисковые термины по границам пробелов. Каждый поисковой термин сопоставляется с URL и заголовком элемента истории без учета регистра. Элемент истории будет возвращён, если все поисковые термины совпадут.

Например, рассмотрите этот элемент:

URL: "http://example.org"

Заголовок: "Example Domain"

"http"              -> matches
"domain"            -> matches
"MAIN ample"        -> matches
"main tt"           -> matches
"main https"        -> does not match

Укажите пустую строку (""), чтобы получить все объекты history.HistoryItem, которые соответствуют всем остальным критериям.

startTime Необязательно

number или string или object. Значение, обозначающее дату и время. Это может быть: объект Date, строка даты в формате ISO 8601, или количество миллисекунд, прошедших с эпохи. Если задано, этот параметр исключает результаты, чья lastVisitTime раньше указанного времени. Если параметр опущен, поиск ограничен последними 24 часами.

endTime Необязательно

number или string или object. Значение, обозначающее дату и время. Это может быть: объект Date, строка даты в формате ISO 8601, или количество миллисекунд, прошедших с эпохи. Если задано, этот параметр ограничивает результаты посещениями до указанной даты. Если опущено, то все записи рассматриваются с момента времени начала.

maxResults Необязательно

number. Максимальное количество результатов для извлечения. По умолчанию 100, с минимальным значением 1. Функция выдаст ошибку, если вы передадите значение maxResults меньше 1.

Возвращаемое значение

Будет возвращён Promise, который будет выполнен с массивом объектов типа history.HistoryItem, каждый из которых описывает один соответствующий элемент истории. Элементы отсортированы в обратном хронологическом порядке.

Примеры

Выводит URL и время последнего посещения для всех элементов истории, посещенных в последние 24 часа:

function onGot(historyItems) {
  for (const item of historyItems) {
    console.log(item.url);
    console.log(new Date(item.lastVisitTime));
  }
}

browser.history.search({ text: "" }).then(onGot);

Выводит URL и время последнего посещения для всех элементов истории, когда-либо посещённых:

function onGot(historyItems) {
  for (const item of historyItems) {
    console.log(item.url);
    console.log(new Date(item.lastVisitTime));
  }
}

browser.history
  .search({
    text: "",
    startTime: 0,
  })
  .then(onGot);

Выводит URL и время последнего посещения страницы, содержащей строку "mozilla":

function onGot(historyItems) {
  for (const item of historyItems) {
    console.log(item.url);
    console.log(new Date(item.lastVisitTime));
  }
}

browser.history
  .search({
    text: "mozilla",
    startTime: 0,
    maxResults: 1,
  })
  .then(onGot);

Примеры расширений

  • history-deleter

Совместимость с браузерами

Рабочие столы Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari на IOS Samsung Internet
search Да 79 49 ? Да Нет ? ? Нет ? Нет ?

Примечание: Этот API основан на API chrome.history Chromium. Данная документация взята из history.json кода Chromium.

© 2005–2023 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/history/search

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API