chrome.devtools.network

Descrição

Use a API chrome.devtools.network para recuperar as informações sobre solicitações de rede mostradas pelas Ferramentas para desenvolvedores no painel Network.

Manifesto

As chaves a seguir precisam ser declaradas no manifesto para usar essa API.

"devtools_page"

Consulte o resumo das APIs do DevTools para uma introdução geral ao uso das APIs das ferramentas de desenvolvimento.

Visão geral

As informações de solicitações de rede são representadas no formato de arquivo HTTP (HAR). A descrição do HAR está fora do escopo deste documento. Consulte a especificação HAR v1.2.

Em termos de HAR, o método chrome.devtools.network.getHAR() retorna todo o registro HAR, enquanto o evento chrome.devtools.network.onRequestFinished fornece a entrada HAR como um argumento para o callback de evento.

O conteúdo da solicitação não é fornecido como parte do HAR por motivos de eficiência. Você pode chamar o método getContent() da solicitação para recuperar o conteúdo.

Se a janela "Ferramentas do desenvolvedor" for aberta depois que a página for carregada, algumas solicitações poderão estar ausentes na matriz de entradas retornada por getHAR(). Recarregue a página para receber todas as solicitações. Em geral, a lista de solicitações retornada por getHAR() deve corresponder à mostrada no painel Network.

Exemplos

O código a seguir registra os URLs de todas as imagens maiores que 40 KB à medida que são carregadas:

chrome.devtools.network.onRequestFinished.addListener(
  function(request) {
    if (request.response.bodySize > 40*1024) {
      chrome.devtools.inspectedWindow.eval(
          'console.log("Large image: " + unescape("' +
          escape(request.request.url) + '"))');
    }
  }
);

Para testar essa API, instale os exemplos da API devtools no repositório chrome-extension-samples (link em inglês).

Tipos

Request

Representa uma solicitação de rede para um recurso de documento (script, imagem etc.). Consulte a especificação HAR para referência.

Propriedades

  • getContent

    void

    Promessa

    Retorna o conteúdo do corpo da resposta.

    A função getContent tem esta aparência:

    (callback?: function) => {...}

    • callback

      função opcional

      O parâmetro callback tem esta aparência:

      (response: object) => void

      • resposta

        objeto

        Pendente

        Um objeto que contém o corpo da resposta e a codificação dele.

        • conteúdo

          string

          Conteúdo do corpo da resposta (potencialmente codificado).

        • encoding

          string

          Vazio se o conteúdo não estiver codificado. Caso contrário, o nome da codificação. Atualmente, apenas a codificação de base64 é suportada.

    • retorna

      Promise<object>

      Pendente

      Uma função que recebe o corpo da resposta quando a solicitação é concluída.

      As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Métodos

getHAR()

Promessa
chrome.devtools.network.getHAR(
  callback?: function,
)
: Promise<object>

Retorna o registro HAR que contém todas as solicitações de rede conhecidas.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    (harLog: object) => void

    • harLog

      objeto

      Um registro HAR. Consulte a especificação HAR para mais detalhes.

Retorna

  • Promise<object>

    Pendente

    Uma função que recebe o registro HAR quando a solicitação é concluída.

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onNavigated

chrome.devtools.network.onNavigated.addListener(
  callback: function,
)

Disparado quando a janela inspecionada navega para uma nova página.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (url: string) => void

    • url

      string

onRequestFinished

chrome.devtools.network.onRequestFinished.addListener(
  callback: function,
)

Disparado quando uma solicitação de rede é concluída e todos os dados da solicitação estão disponíveis.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

    (request: Request) => void