CKTIS / JavaScript
IDBRequest: resultaat, fout en gebeurtenishandlers
Lees `result` na een geslaagd IndexedDB-verzoek en `error` na een mislukt verzoek. Een geslaagd verzoek betekent niet dat de transactie is vastgelegd.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
// 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 is een verzoekobject van IndexedDB, geen Promise. IndexedDB is een web-API en maakt geen deel uit van ECMAScript 2024; de beschikbaarheid hangt af van de uitvoeringsomgeving. Zolang readyState de waarde "pending" heeft, veroorzaakt het lezen van de alleen-lezen eigenschappen result of error een DOMException met de naam InvalidStateError. Bij de status "done" kun je deze eigenschappen lezen, maar die status betekent niet dat het verzoek is geslaagd. Een IDBOpenDBRequest kan tijdens upgradeneeded al "done" aangeven, voordat de afsluitende gebeurtenis success of error optreedt.
Wijs functies toe aan request.onsuccess en request.onerror voor respectievelijk success en error. Een nieuwe toewijzing vervangt de vorige handler; met addEventListener() kun je afzonderlijke listeners toevoegen met de gebeurtenisnaam zonder on. Lees bij succes request.result: de waarde hangt af van de bewerking. Zo levert add() de sleutel via result, terwijl get() kan slagen met undefined als de sleutel ontbreekt. Bij succes is request.error gelijk aan null; bij een mislukking bevat die eigenschap een DOMException en is request.result gelijk aan undefined. Een try...catch rond de aanroep kan een synchrone uitzondering uit die aanroep opvangen, maar niet een latere mislukking van het verzoek.
De gebeurtenis success bubbelt niet en kan niet worden geannuleerd. Bij een verzoek binnen een transactie bubbelt error wel en wordt de transactie standaard afgebroken. Roep event.preventDefault() aan in de handler voor een verwachte, herstelbare fout om dat standaardgedrag te verhinderen. Het verzoek blijft mislukt en de gebeurtenis blijft bubbelen.
Een geslaagd schrijfverzoek betekent niet dat de transactie is vastgelegd. Dien verdere verzoeken in zolang de transactie actief is, bijvoorbeeld rechtstreeks in een gebeurtenishandler van een verzoek. Luister op de transactie naar complete voor het vastleggen en naar abort voor het terugdraaien.
Voorbeelden
<!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>Resultaat
success: 1 error: ConstraintError transaction: complete
Sla het voorbeeld op als HTML-bestand en bied het aan via HTTPS. Open de pagina in een browser waarin IndexedDB en `crypto.randomUUID()` beschikbaar zijn en bekijk de uitvoer in de ontwikkelaarsconsole. De eerste `add()` levert sleutel `1` via `result`; de tweede mislukt met `ConstraintError`. `preventDefault()` voorkomt dat die fout de transactie afbreekt, zodat de transactie `complete` kan afvuren. Na afloop sluit de code de verbinding en vraagt die om verwijdering van de database die voor deze uitvoering is aangemaakt.
Gerelateerde lessen
- JavaScript · Les 31 · Gevorderd · Versie: 4