chrome.debugger

vernieuwingsdatum: 2026-09-25 robots: noindex

Beschrijving

De chrome.debugger API dient als alternatief transport voor het protocol voor foutopsporing op afstand van Chrome. Gebruik chrome.debugger om aan een of meer tabbladen te koppelen om netwerkinteractie te instrumenteren, JavaScript te debuggen, het DOM en CSS te muteren en meer. Gebruik de property Debuggee tabId om tabbladen te targeten met sendCommand en gebeurtenissen te routeren op tabId vanuit onEvent-callbacks.

Rechten

debugger

.

Beveiligingsmelding

Om veiligheidsredenen biedt de chrome.debugger API geen toegang tot alle Chrome DevTools-protocol-domeinen. De beschikbare domeinen zijn: Toegankelijkheid, Audits, CacheStorage, Console, CSS, Database, Debugger, DOM, DOMDebugger, DOMSnapshot, Emulation, Fetch, IO, Input, Inspector, Log, Network, Overlay, Page, Performance, Runtime, Storage, Target, Tracing, WebAudio en WebAuthn.

Manifest

Je moet het recht "debugger" definiëren in het manifest van je extensie om deze API te kunnen gebruiken.

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

Voorbeelden

Als je deze API wilt uitproberen, installeer je het voorbeeld van de debugger-API uit de repository chrome-extension-samples.

Typen

Debuggee

ID van het foutopsporingsproces. TabId, extensionId of targetId moet worden ingevoerd

Eigenschappen

  • extensionId

    tekenreeks optioneel

    De ID van de extensie die je wilt debuggen. Koppelen aan een achtergrondpagina van een extensie is alleen mogelijk als de opdrachtregeloptie --silent-debugger-extension-api wordt gebruikt.

  • tabId

    nummer optioneel

    De ID van het tabblad dat je wilt debuggen.

  • targetId

    tekenreeks optioneel

    De ondoorzichtige ID van het foutopsporingsdoel.

DebuggerSession

Chrome 125+

ID van de foutopsporingssessie. Er moet een tabId, extensionId of targetId worden ingevoerd. Je kunt ook een optionele sessie-ID invoeren. Als sessionId is ingevoerd voor argumenten die vanuit onEvent worden gestuurd, betekent dit dat de gebeurtenis afkomstig is van een onderliggende protocol-sessie binnen de sessie van de root-foutopsporing. Als sessionId wordt gespecificeerd wanneer deze wordt doorgegeven aan sendCommand, wordt een onderliggende protocolsessie binnen de root-foutopsporingssessie getarget.

Eigenschappen

  • extensionId

    tekenreeks optioneel

    De ID van de extensie die je wilt debuggen. Koppelen aan een achtergrondpagina van een extensie is alleen mogelijk als de opdrachtregeloptie --silent-debugger-extension-api wordt gebruikt.

  • sessionId

    tekenreeks optioneel

    De niet-zichtbare ID van de Chrome DevTools Protocol-sessie. Identificeert een kindersessie binnen de rootsessie die wordt geïdentificeerd door tabId, extensionId of targetId.

  • tabId

    nummer optioneel

    De ID van het tabblad dat je wilt debuggen.

  • targetId

    tekenreeks optioneel

    De ondoorzichtige ID van het foutopsporingsdoel.

DetachReason

Chrome 44 en hoger

Reden voor beëindiging van verbinding.

Enum

"target_closed"

"canceled_by_user"

TargetInfo

Informatie over foutopsporingstargets

Eigenschappen

  • gekoppeld

    booleaans

    Waar als de foutopsporing al is bijgevoegd.

  • extensionId

    tekenreeks optioneel

    De extensie-ID, gedefinieerd als type = 'background_page'.

  • faviconUrl

    tekenreeks optioneel

    URL van het doel-favicon.

  • id

    tekenreeks

    Doel-ID.

  • tabId

    nummer optioneel

    De tabblad-ID, gedefinieerd als type == 'page'.

  • titel

    tekenreeks

    Titel van de doelpagina.

  • Doeltype.

  • url

    tekenreeks

    Doel-URL.

TargetInfoType

Chrome 44 en hoger

Doeltype.

Enum

"page"

"background_page"

"worker"

"other"

Methoden

attach()

Belofte 
chrome.debugger.attach(
  target: Debuggee,
  requiredVersion: string,
  callback?: function,
): Promise<void>

Hiermee wordt de debugger aan het aangegeven doel gekoppeld.

Parameters

  • target

    Debuggee

    Foutopsporingsdoel waaraan je wilt koppelen.

  • requiredVersion

    tekenreeks

    Vereiste versie van het foutopsporingsprotocol (0.1). Je kunt alleen koppelen aan de foutopsporingsdoel met een overeenkomende hoofdversie en een onderversie die gelijk is aan of hoger is dan de onderversie van de foutopsporingsdoel. Hier vind je een lijst met de protocolversies.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 96+

    Wordt opgelost als de bijvoegbewerking is geslaagd of mislukt. De belofte wordt omgezet zonder waarde. Als het bijvoegen mislukt, wordt de belofte geweigerd.

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

detach()

Belofte 
chrome.debugger.detach(
  target: Debuggee,
  callback?: function,
): Promise<void>

Ontkoppelt de foutopsporing van het gegeven doel.

Parameters

  • target

    Debuggee

    Foutopsporingsdoel waarvan je wilt loskoppelen.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 96+

    Wordt opgelost als de loskoppelingsbewerking is gelukt of mislukt. De belofte wordt omgezet zonder waarde. Als het loskoppelen mislukt, wordt de belofte geweigerd.

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getTargets()

Belofte 
chrome.debugger.getTargets(
  callback?: function,
): Promise<TargetInfo[]>

Geeft de lijst met beschikbare foutopsporingsdoelen terug.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: TargetInfo[]) => void

    • resultaat

      TargetInfo[]

      Matrix van TargetInfo-objecten die overeenkomen met de beschikbare foutopsporingstargets.

Retourzendingen

  • Promise<TargetInfo[]>

    Chrome 96+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

sendCommand()

Belofte 
chrome.debugger.sendCommand(
  target: DebuggerSession,
  method: string,
  commandParams?: object,
  callback?: function,
): Promise<object | undefined>

Stuurt de gegeven opdracht naar het foutopsporingsdoel.

Parameters

  • Foutopsporingsdoel waarnaar je de opdracht wilt sturen.

  • method

    tekenreeks

    Methodenaam. Moet een van de methoden zijn die zijn gedefinieerd door het protocol voor foutopsporing op afstand.

  • commandParams

    object optioneel

    Json-object met verzoekparameters. Dit object moet voldoen aan het schema voor parameters voor foutopsporing op afstand voor de aangegeven methode.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result?: object) => void

    • resultaat

      object optioneel

      Json-object met de reactie. De structuur van de reactie verschilt afhankelijk van de methodenaam en wordt gedefinieerd door het kenmerk returns van de opdrachtbeschrijving in het protocol voor foutopsporing op afstand.

Retourzendingen

  • Promise<object | undefined>

    Chrome 96+

    Tekstgedeelte van reactie Als er een fout optreedt tijdens het posten van het bericht, wordt de belofte geweigerd.

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onDetach

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

Wordt geactiveerd als de browser de foutopsporingssessie voor het tabblad beëindigt. Dit gebeurt als het tabblad wordt gesloten of als Chrome DevTools wordt aangeroepen voor het bijgevoegde tabblad.

Parameters

onEvent

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

Wordt geactiveerd wanneer het instrumentatiegebeurtenis voor foutopsporing van het doel wordt geactiveerd.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

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