chrome.debugger

Описание

API chrome.debugger служит альтернативным транспортом для протокола удалённой отладки Chrome. Используйте chrome.debugger для подключения к одной или нескольким вкладкам для мониторинга сетевого взаимодействия, отладки JavaScript, изменения DOM и CSS и других задач. Используйте свойство tabId объекта Debuggee для выбора вкладок с помощью sendCommand и маршрутизации событий по tabId из обратных вызовов onEvent .

Разрешения

debugger

Примечание по безопасности

Из соображений безопасности API chrome.debugger не предоставляет доступ ко всем доменам протокола Chrome DevTools. Доступны следующие домены: Accessibility , Audits , CacheStorage , Console , CSS , Database , Debugger , DOM , DOMDebugger , DOMSnapshot , Emulation , Fetch , IO , Input , Inspector , Log , Network , Overlay , Page , Performance , Profiler , Runtime , Storage , Target , Tracing , WebAudio и WebAuthn .

Манифест

Для использования этого API необходимо объявить разрешение "debugger" в манифесте вашего расширения.

{
  "name": "My extension",
  ...
  "permissions": [
    "debugger",
  ],
  ...
}

Примеры

Чтобы опробовать этот API, установите пример API отладчика из репозитория chrome-extension-samples .

Типы

Debuggee

Идентификатор отлаживаемого объекта. Необходимо указать tabId, extensionId или targetId.

Характеристики

  • extensionId

    строка необязательная

    Идентификатор расширения, которое вы собираетесь отлаживать. Присоединение к фоновой странице расширения возможно только при использовании ключа командной строки --silent-debugger-extension-api .

  • tabId

    номер необязательно

    Идентификатор вкладки, которую вы собираетесь отладить.

  • targetId

    строка необязательная

    Непрозрачный идентификатор цели отладки.

DebuggerSession

Хром 125+

Идентификатор сеанса отладчика. Необходимо указать один из следующих вариантов: tabId, extensionId или targetId. Кроме того, можно указать необязательный sessionId. Если для аргументов, отправляемых функцией onEvent , указан sessionId , это означает, что событие исходит из сеанса дочернего протокола внутри корневого сеанса отлаживаемого объекта. Если sessionId указан при передаче в sendCommand , он будет направлен на сеанс дочернего протокола внутри корневого сеанса отлаживаемого объекта.

Характеристики

  • extensionId

    строка необязательная

    Идентификатор расширения, которое вы собираетесь отлаживать. Присоединение к фоновой странице расширения возможно только при использовании ключа командной строки --silent-debugger-extension-api .

  • sessionId

    строка необязательная

    Непрозрачный идентификатор сеанса протокола Chrome DevTools. Идентифицирует дочерний сеанс внутри корневого сеанса, определяемого tabId, extensionId или targetId.

  • tabId

    номер необязательно

    Идентификатор вкладки, которую вы собираетесь отладить.

  • targetId

    строка необязательная

    Непрозрачный идентификатор цели отладки.

DetachReason

Хром 44+

Причина разрыва соединения.

Перечисление

"target_closed"

"отменено_пользователем"

TargetInfo

Отладочная целевая информация

Характеристики

  • прикрепил

    булев

    True, если отладчик уже подключен.

  • extensionId

    строка необязательная

    Идентификатор расширения, определяемый, если type = 'background_page'.

  • faviconUrl

    строка необязательная

    URL-адрес целевого значка.

  • идентификатор

    нить

    Идентификатор цели.

  • tabId

    номер необязательно

    Идентификатор вкладки, определяемый, если type == 'page'.

  • заголовок

    нить

    Заголовок целевой страницы.

  • Тип цели.

  • URL-адрес

    нить

    Целевой URL.

TargetInfoType

Хром 44+

Тип цели.

Перечисление

"страница"

"background_page"

"работник"

"другой"

Методы

attach()

Обещать
chrome.debugger.attach(
  target: Debuggee,
  requiredVersion: string,
  callback?: function,
): Promise<void>

Присоединяет отладчик к указанной цели.

Параметры

  • Цель отладки, к которой вы хотите присоединитьс.

  • requiredVersion

    нить

    Требуемая версия протокола отладки ("0.1"). Подключиться можно только к отлаживаемому объекту с совпадающей основной версией и большей или равной ей дополнительной версией. Список версий протокола можно получить здесь .

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 96+

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

detach()

Обещать
chrome.debugger.detach(
  target: Debuggee,
  callback?: function,
): Promise<void>

Отключает отладчик от заданной цели.

Параметры

  • Цель отладки, от которой вы хотите отсоединиться.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    () => void

Возврат

  • Обещание<void>

    Хром 96+

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

getTargets()

Обещать
chrome.debugger.getTargets(
  callback?: function,
): Promise<TargetInfo[]>

Возвращает список доступных целей отладки.

Параметры

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (result: TargetInfo[]) => void

    • результат

      TargetInfo []

      Массив объектов TargetInfo, соответствующих доступным целям отладки.

Возврат

  • Обещание< TargetInfo []>

    Хром 96+

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

sendCommand()

Обещать
chrome.debugger.sendCommand(
  target: DebuggerSession,
  method: string,
  commandParams?: object,
  callback?: function,
): Promise<object | undefined>

Отправляет заданную команду в цель отладки.

Параметры

  • цель

    DebuggerSession

    Цель отладки, которой вы хотите отправить команду.

  • метод

    нить

    Имя метода. Должно быть одним из методов, определённых протоколом удалённой отладки .

  • commandParams

    объект необязательный

    JSON-объект с параметрами запроса. Этот объект должен соответствовать схеме параметров удалённой отладки для данного метода.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (result?: object) => void

    • результат

      объект необязательный

      JSON-объект с ответом. Структура ответа зависит от имени метода и определяется атрибутом return в описании команды в протоколе удалённой отладки.

Возврат

  • Обещание<объект | неопределенный>

    Хром 96+

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

События

onDetach

chrome.debugger.onDetach.addListener(
  callback: function,
)

Возникает, когда браузер завершает сеанс отладки для вкладки. Это происходит либо при закрытии вкладки, либо при вызове Chrome DevTools для прикреплённой вкладки.

Параметры

onEvent

chrome.debugger.onEvent.addListener(
  callback: function,
)

Запускается всякий раз, когда отладочная цель выдает событие инструментирования.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

    (source: DebuggerSession, method: string, params?: object) => void

    • источник

      DebuggerSession

    • метод

      нить

    • параметры

      объект необязательный