Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

AbortSignal — sinal de cancelamento

AbortSignal transmite um pedido de cancelamento a fetch; AbortController inicia o cancelamento, enquanto o sinal expõe o respetivo estado.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

const controller = new AbortController();
const signal = controller.signal;
fetch(url, { signal });
controller.abort(reason);

AbortSignal transmite um pedido de cancelamento a uma operação que o suporte. Obtém-no através de controller.signal de um AbortController e passa-o a fetch como { signal }. É o controlador, e não o sinal, que inicia o cancelamento.

Após o cancelamento, signal.aborted tem o valor true. Se a Promise devolvida por fetch ainda estiver pendente, o cancelamento faz com que seja rejeitada com o motivo do cancelamento. Se a Promise já tiver sido cumprida com um objeto Response, o cancelamento não pode provocar a sua rejeição retroativa, mas ainda pode interromper a leitura do corpo da resposta. Isto não desfaz as ações do servidor.

O exemplo cancela antes de chamar fetch, pelo que o resultado não depende da rede. Esta é uma Web API, não uma funcionalidade de ECMAScript; a presença do Node 24 no repositório não comprova o suporte nos browsers.

Exemplos

async function main() {
  const controller = new AbortController();
  const signal = controller.signal;
  const reason = new Error("Stopped");

  controller.abort(reason);

  try {
    await fetch("data:text/plain,hello", { signal });
  } catch (error) {
    console.log(signal.aborted);
    console.log(error === reason);
  }
}

main();

Resultado

true
true

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes