CKTIS / JavaScript
IDBRequest: resultado y error de una solicitud
Aprende cuándo leer `result` y `error` en IndexedDB y a distinguir el éxito de una solicitud de la confirmación de su transacción.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
request.readyState; // "pending" or "done"
request.result; // operation-specific value on success; undefined on failure
request.error; // null on success; DOMException on failure
// Reading result or error while readyState is "pending" throws InvalidStateError.result y error son dos propiedades de solo lectura de una instancia de IDBRequest. Una solicitud de IndexedDB representa una operación asíncrona. No es una promesa (Promise), así que await request no espera a que termine la operación. IndexedDB es una API de la plataforma web, no forma parte de ECMAScript 2024, y su disponibilidad depende del entorno de ejecución.
Mientras request.readyState sea "pending", leer cualquiera de las propiedades lanza una DOMException llamada InvalidStateError. El estado "done" no implica éxito por sí solo. Normalmente, lee el resultado en el manejador de success. Una excepción: en el manejador de upgradeneeded de una solicitud de indexedDB.open(), result ya está disponible para cambiar el esquema, aunque aún no se haya disparado el evento success final.
En success, error vale null y result depende de la operación: open() proporciona una conexión IDBDatabase, add() da la clave del registro guardado y get() puede dar undefined si ningún registro coincide con la clave. En error, result vale undefined y error contiene una DOMException. Consulta request.error.name para identificar un fallo como ConstraintError. Un resultado undefined no basta para concluir que hubo un fallo. Un try...catch alrededor de la llamada a la API captura excepciones síncronas, no fallos notificados más tarde mediante un evento error.
El éxito de una solicitud de escritura no significa que su transacción se haya confirmado. Escucha complete para confirmar el commit y abort para detectar una reversión. Por defecto, el error de una solicitud dentro de una transacción provoca la cancelación de esta. Si el error es esperado y puedes gestionarlo con seguridad, llama a event.preventDefault() en el manejador de error de la solicitud para evitar esa cancelación por defecto; la solicitud seguirá habiendo fallado.
Ejemplos
<!doctype html>
<meta charset="utf-8">
<title>IDBRequest result and error</title>
<script>
(() => {
const { indexedDB, crypto } = window;
const name = `cktis-idbrequest-${crypto.randomUUID()}`;
const open = 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");
const cleanup = () => {
db.close();
const removal = indexedDB.deleteDatabase(name);
removal.onerror = () => console.error("cleanup:", removal.error.name);
};
tx.oncomplete = () => {
console.log("transaction: complete");
cleanup();
};
tx.onabort = () => {
console.error("transaction: abort", tx.error?.name);
cleanup();
};
const first = store.add("first", 1);
first.onsuccess = () => {
console.log(`first: result=${first.result}, error=${first.error}`);
const second = store.add("second", 1);
second.onerror = (event) => {
if (second.error.name === "ConstraintError") event.preventDefault();
console.log(`second: result=${second.result}, error=${second.error.name}`);
};
};
};
})();
</script>Resultado
first: result=1, error=null second: result=undefined, error=ConstraintError transaction: complete
Abre el ejemplo como una página HTML servida por HTTPS que disponga de IndexedDB y `crypto.randomUUID()`. Consulta los mensajes en la consola del navegador. El segundo `add()` intenta usar la misma clave. El manejador evita la cancelación por defecto solo para el `ConstraintError` esperado, de modo que la primera escritura puede confirmarse. Al terminar la transacción, el código cierra la conexión y solicita eliminar la base de datos de prueba.
Lecciones relacionadas
- JavaScript · Lección 20 · Intermedio · Versión: 3
- JavaScript · Lección 21 · Intermedio · Versión: 3
Fuentes
- IDBRequest: result property
- IDBRequest: error property
- IDBRequest
- IDBRequest: readyState property
- IDBFactory: open() method
- IDBOpenDBRequest: upgradeneeded event
- IDBObjectStore: add() method
- IDBObjectStore: get() method
- IDBTransaction
- IDBTransaction: complete event
- IDBFactory: deleteDatabase() method
- Crypto: randomUUID() method