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

CKTIS / JavaScript

Eventos de transação do IndexedDB: complete, abort e error

Usa `complete` e `abort` para saber o resultado de toda a transação do IndexedDB e `error` para perceber por que falhou um pedido individual.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

tx.addEventListener("complete", onComplete);
tx.addEventListener("abort", onAbort);
tx.addEventListener("error", onRequestError);

// Property-based alternatives:
tx.oncomplete = onComplete;
tx.onabort = onAbort;
tx.onerror = onRequestError;

// Read the transaction's error, if any:
const failure = tx.error;

// To explicitly roll back a transaction that can still be aborted:
tx.abort();

Escuta complete, abort e error na transação tx com addEventListener() ou através das propriedades oncomplete, onabort e onerror. complete significa que a transação inteira foi confirmada. O evento success de um pedido não basta: uma falha posterior ainda pode reverter as suas alterações. A confirmação não significa necessariamente que os dados já foram escritos fisicamente no disco; isso depende da configuração de durabilidade e do ambiente de execução.

abort indica que a transação terminou sem confirmação e que as suas alterações foram revertidas. O evento propaga-se até IDBDatabase e não é cancelável. Pode ocorrer após uma chamada explícita a tx.abort() ou devido a uma falha. No manipulador de abort, lê tx.error: esta propriedade só de leitura contém uma DOMException que descreve a falha ou null, como após uma chamada explícita a tx.abort().

O evento error tem origem num IDBRequest e propaga-se até à base de dados através de tx. Para saber a causa do erro do pedido, lê event.target.error, não tx.error, que pode ainda ser null. Por predefinição, um erro num pedido interrompe a transação. Perante um erro esperado, chama event.preventDefault() no manipulador para impedir essa interrupção específica; stopPropagation() por si só não basta. O pedido continua a ter falhado. Usa complete ou abort para conhecer o resultado final da transação.

IndexedDB é uma API da plataforma Web, não faz parte de ECMAScript 2024. Adiciona pedidos enquanto a transação estiver ativa, por exemplo logo após a sua criação ou nos manipuladores dos seus pedidos. Depois de aguardares uma operação independente, como fetch(), a transação pode já não aceitar pedidos. A disponibilidade depende do ambiente de execução e da política de armazenamento.

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IndexedDB transaction events</title>
</head>
<body>
<pre id="output"></pre>
<script>
void (async () => {
  const output = document.getElementById("output");
  function log(line) {
    console.log(line);
    output.textContent += `${line}\n`;
  }

  const name = `cktis-tx-${Date.now()}-${Math.random().toString(36).slice(2)}`;
  const indexedDB = window.indexedDB;
  const open = indexedDB.open(name, 1);
  open.onupgradeneeded = () => open.result.createObjectStore("items");
  const db = await new Promise((resolve, reject) => {
    open.onsuccess = () => resolve(open.result);
    open.onerror = () => reject(open.error);
  });

  function write(label, cancelError) {
    return new Promise((resolve) => {
      const tx = db.transaction("items", "readwrite");
      tx.oncomplete = () => resolve("complete");
      tx.onabort = () => resolve(`abort: ${tx.error?.name ?? "no error"}`);
      tx.onerror = (event) => {
        log(`${label} error: ${event.target.error.name}`);
      };

      const items = tx.objectStore("items");
      items.add("first", label);
      const duplicate = items.add("second", label);
      if (cancelError) {
        duplicate.onerror = (event) => {
          if (duplicate.error.name === "ConstraintError") event.preventDefault();
        };
      }
    });
  }

  try {
    for (const [label, cancelError] of [["rollback", false], ["recover", true]]) {
      log(`${label} ${await write(label, cancelError)}`);
    }

    const values = await new Promise((resolve, reject) => {
      const tx = db.transaction("items", "readonly");
      const items = tx.objectStore("items");
      const rolledBack = items.get("rollback");
      const recovered = items.get("recover");
      tx.oncomplete = () => resolve([rolledBack.result, recovered.result]);
      tx.onabort = () => reject(tx.error ?? new Error("Read aborted"));
    });
    log(`stored: ${values.map(String).join(",")}`);
  } finally {
    db.close();
    await new Promise((resolve, reject) => {
      const deletion = indexedDB.deleteDatabase(name);
      deletion.onsuccess = () => resolve();
      deletion.onerror = () => reject(deletion.error);
    });
  }
})().catch(console.error);
</script>
</body>
</html>

Resultado

rollback error: ConstraintError
rollback abort: ConstraintError
recover error: ConstraintError
recover complete
stored: undefined,first

Disponibiliza o exemplo como página HTML por HTTPS e abre-a num navegador que tenha IndexedDB disponível e permita o armazenamento de dados. Ambas as transações assinalam `ConstraintError` devido a uma chave duplicada. A primeira reverte a escrita inicial; a segunda confirma-a porque o manipulador de erros impede a ação predefinida.

Lições relacionadas

  • JavaScript · Lição 20 · Intermédio · Versão: 3
  • JavaScript · Lição 21 · Intermédio · Versão: 3

Fontes