scripting.executeScript()

details

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

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

Массив аргументов для передачи в функцию. Это допустимо только в том случае, если указан параметр func. Аргументы должны быть сериализуемыми в JSON.

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

array из string. Массив путей JS-файлов для вставки, относительно корневого каталога расширения. Должен быть указан ровно один из files и func.

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

function. JavaScript-функция для вставки. Эта функция сериализуется и затем десериализуется для вставки. Это означает, что любые связанные параметры и контекст выполнения теряются. Должен быть указан ровно один из files и func.

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

boolean. Указывает, вызывается ли вставка в целевой объект как можно скорее, но не обязательно до загрузки страницы.

target

scripting.InjectionTarget. Детали, определяющие цель для вставки скрипта.

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

scripting.ExecutionWorld. Среда выполнения для выполнения скрипта.

A Promise, который выполняется с массивом InjectionResult объектов, представляющих результат вставленного скрипта в каждом вставленном фрейме.

Обещание отклоняется, если вставка завершается неудачей, например, когда целевой объект вставки недействителен. Когда выполнение скрипта началось, его результат включается в результат, будь то успешно (как result) или неудачно (как error).

Каждый InjectionResult объект имеет следующие свойства:

frameId

number. Идентификатор фрейма, связанный с вставкой.

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

any. Результат выполнения скрипта.

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

any. Если возникает ошибка, содержит значение, выброшенное или отклоненное скриптом. Обычно это объект ошибки с свойством message, но это может быть любое значение (включая примитивы и undefined).

Chrome пока не поддерживает свойство error (см. Проблема 1271527: Распространение ошибок из scripting.executeScript в InjectionResult). В качестве альтернативы, ошибки выполнения можно перехватывать, обернув исполняемый код в оператор try-catch. Неперехваченные ошибки также сообщаются в консоль целевого вкладки.

Результатом скрипта является последнее вычисленное выражение, что аналогично результатам, которые вы увидите, если выполните скрипт в Консоли веб-разработчика (без любого console.log() вывода). Например, рассмотрим такой скрипт:

let foo='my result'; foo;

Здесь массив results содержит строку "my result" в качестве элемента.

Значения результатов должны быть структурно клонируемыми (см. Алгоритм клонирования данных).

В этом примере выполняется однострочный фрагмент кода в активной вкладке:

browser.action.onClicked.addListener(async (tab) => {
  try {
    await browser.scripting.executeScript({
      target: {
        tabId: tab.id,
      },
      func: () => {
        document.body.style.border = "5px solid green";
      },
    });
  } catch (err) {
    console.error(`failed to execute script: ${err}`);
  }
});

В этом примере выполняется скрипт из файла (упакованного с расширением) под названием "content-script.js". Скрипт выполняется в активной вкладке. Скрипт выполняется во вложенных фреймах и в основном документе:

browser.action.onClicked.addListener(async (tab) => {
  try {
    await browser.scripting.executeScript({
      target: {
        tabId: tab.id,
        allFrames: true,
      },
      files: ["content-script.js"],
    });
  } catch (err) {
    console.error(`failed to execute script: ${err}`);
  }
});