CKTIS / JavaScript
IDBRequest: resultado, error y manejadores de eventos
Lee `result` cuando una solicitud de IndexedDB tenga éxito y `error` cuando falle. Que una solicitud tenga éxito no significa que la transacción se haya confirmado.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
// Read-only members; do not read either while readyState is "pending".
// request.result
// request.error
request.onsuccess = (event) => { /* read request.result */ };
request.onerror = (event) => { /* read request.error */ };
// Alternative registration; event names omit the "on" prefix.
request.addEventListener("success", handleSuccess);
request.addEventListener("error", handleError);IDBRequest es un objeto de solicitud de IndexedDB, no una promesa (Promise). IndexedDB es una API web, no forma parte de ECMAScript 2024 y su disponibilidad depende del entorno de ejecución. Mientras readyState sea "pending", leer cualquiera de las propiedades de solo lectura result o error lanza una DOMException denominada InvalidStateError. El estado "done" permite leer estas propiedades, pero no garantiza que la solicitud haya tenido éxito. Una solicitud IDBOpenDBRequest puede indicar "done" durante upgradeneeded, antes de que se emita el evento final success o error.
Asigna funciones a request.onsuccess y request.onerror para gestionar success y error, respectivamente. Una reasignación sustituye al manejador anterior; con addEventListener() puedes agregar escuchas independientes usando el nombre del evento sin on. Si la solicitud tiene éxito, lee request.result: su valor depende de la operación. Por ejemplo, add() entrega la clave a través de result, mientras que get() puede tener éxito con undefined si la clave no existe. En caso de éxito, request.error vale null; en caso de fallo, contiene una DOMException y request.result vale undefined. Un try...catch alrededor de la llamada puede capturar una excepción síncrona de esa llamada, pero no un fallo posterior de la solicitud.
El evento success no se propaga hacia arriba ni se puede cancelar. En una solicitud que pertenece a una transacción, error se propaga hacia arriba y, por defecto, provoca que se aborte la transacción. Llama a event.preventDefault() en el manejador de un error esperado y recuperable para impedir ese aborto por defecto. Esto no convierte el fallo en un éxito ni detiene la propagación del evento.
El éxito de una solicitud de escritura no significa que la transacción se haya confirmado. Envía las siguientes solicitudes mientras la transacción esté activa, por ejemplo directamente en un manejador de eventos de una solicitud. En la transacción, escucha complete para detectar la confirmación y abort para detectar la reversión.
Ejemplos
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IDBRequest: success and error</title>
</head>
<body>
<p>Open the browser developer console to see the output.</p>
<script>
(() => {
const name = `cktis-idbrequest-${window.crypto.randomUUID()}`;
const open = window.indexedDB.open(name, 1);
open.onupgradeneeded = () => open.result.createObjectStore("items");
open.onerror = () => console.error("open:", open.error.name);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction("items", "readwrite");
const store = tx.objectStore("items");
function cleanup() {
db.close();
const deletion = window.indexedDB.deleteDatabase(name);
deletion.onerror = () => console.error("cleanup:", deletion.error.name);
}
tx.oncomplete = () => {
console.log("transaction: complete");
cleanup();
};
tx.onabort = () => {
console.error("transaction: aborted", tx.error?.name);
cleanup();
};
const first = store.add("first", 1);
first.onsuccess = () => console.log(`success: ${first.result}`);
const duplicate = store.add("second", 1);
duplicate.onerror = (event) => {
const { name } = duplicate.error;
if (name === "ConstraintError") event.preventDefault();
console.log(`error: ${name}`);
};
};
})();
</script>
</body>
</html>Resultado
success: 1 error: ConstraintError transaction: complete
Guarda el ejemplo en un archivo HTML y sírvelo por HTTPS. Abre la página en un navegador con IndexedDB y `crypto.randomUUID()` disponibles y consulta la salida en la consola de desarrollador. El primer `add()` entrega la clave `1` mediante `result`; el segundo falla con `ConstraintError`. `preventDefault()` impide que ese error aborte la transacción, que así puede emitir `complete`. Al terminar la transacción, el código cierra la conexión y solicita la eliminación de la base de datos creada para esa ejecución.
Lecciones relacionadas
- JavaScript · Lección 31 · Avanzado · Versión: 4