Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Eventos de transacción de IndexedDB: complete, abort y error

Usa `complete` y `abort` para conocer el resultado de toda la transacción de IndexedDB, y `error` para diagnosticar el fallo de una solicitud.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

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();

Escucha complete, abort y error en la transacción tx con addEventListener() o con las propiedades oncomplete, onabort y onerror. complete significa que se confirmó la transacción entera. El evento success de una solicitud no basta: un fallo posterior aún puede revertir sus cambios. La confirmación no implica necesariamente que los datos ya se hayan escrito físicamente en disco; depende de la configuración de durabilidad y del entorno de ejecución.

abort significa que la transacción terminó sin confirmarse y que se revirtieron sus cambios. El evento se propaga hasta IDBDatabase y no se puede cancelar. Puede producirse tras una llamada explícita a tx.abort() o por un fallo. En el manejador de abort, lee tx.error: esta propiedad de solo lectura contiene una DOMException que describe el fallo o null, como ocurre tras llamar explícitamente a tx.abort().

El evento error se origina en un IDBRequest y se propaga a la base de datos pasando por tx. Para conocer la causa del fallo de la solicitud, lee event.target.error, no tx.error, que aún puede ser null. De forma predeterminada, un error de solicitud aborta la transacción. Si esperas ese error, llama a event.preventDefault() en su manejador para impedir ese aborto concreto; stopPropagation() por sí solo no basta. La solicitud sigue habiendo fallado. Usa complete o abort para conocer el resultado final.

IndexedDB es una API de la plataforma web, no parte de ECMAScript 2024. Añade solicitudes mientras la transacción esté activa, por ejemplo justo después de crearla o en los manejadores de sus solicitudes. Tras esperar una operación independiente como fetch(), puede que la transacción ya no acepte solicitudes. La disponibilidad depende del entorno de ejecución y de la política de almacenamiento.

Ejemplos

<!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

Sirve el ejemplo como una página HTML por HTTPS y ábrela en un navegador que disponga de IndexedDB y permita el almacenamiento de datos. Ambas transacciones notifican `ConstraintError` por una clave duplicada. La primera revierte su escritura inicial; la segunda la confirma porque el manejador de errores impide la acción predeterminada.

Lecciones relacionadas

  • JavaScript · Lección 20 · Intermedio · Versión: 3
  • JavaScript · Lección 21 · Intermedio · Versión: 3

Fuentes