CKTIS / JavaScript
IDBRequest: resultaat en fout van een verzoek
Leer wanneer je `result` en `error` in IndexedDB leest en hoe je het slagen van een verzoek onderscheidt van het vastleggen van de transactie.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
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 en error zijn twee alleen-lezen eigenschappen van een IDBRequest-instantie. Een IndexedDB-verzoek staat voor een asynchrone bewerking. Het is geen Promise, dus await request wacht niet totdat de bewerking klaar is. IndexedDB is een API van het webplatform, geen onderdeel van ECMAScript 2024. De beschikbaarheid hangt af van de uitvoeromgeving.
Zolang request.readyState gelijk is aan "pending", werpt het lezen van elk van beide eigenschappen een DOMException met de naam InvalidStateError op. De status "done" betekent op zichzelf niet dat het verzoek is geslaagd. Lees het resultaat normaal gesproken in de success-handler. Een uitzondering: in de upgradeneeded-handler van een indexedDB.open()-verzoek is result al beschikbaar om het schema te wijzigen, ook al is de uiteindelijke success-gebeurtenis nog niet opgetreden.
Bij success is error gelijk aan null en hangt result af van de bewerking: open() levert een IDBDatabase-verbinding, add() geeft de sleutel van het opgeslagen record en get() kan undefined opleveren als geen record bij de sleutel past. Bij error is result gelijk aan undefined en bevat error een DOMException. Bekijk request.error.name om een fout zoals ConstraintError te herkennen. undefined alleen wijst niet op een fout. Een try...catch rond de API-aanroep vangt synchrone uitzonderingen op, maar geen fouten die pas later via een error-gebeurtenis worden gemeld.
Een geslaagd schrijfverzoek betekent nog niet dat de transactie is vastgelegd. Luister naar complete om de commit te bevestigen en naar abort om terugdraaiing te herkennen. Een verzoekfout binnen een transactie breekt die transactie standaard af. Als je een verwachte fout veilig kunt afhandelen, voorkomt event.preventDefault() in de error-handler van het verzoek die standaardafbreking. Het mislukte verzoek wordt daardoor niet alsnog succesvol.
Voorbeelden
<!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>Resultaat
first: result=1, error=null second: result=undefined, error=ConstraintError transaction: complete
Open het voorbeeld als een HTML-pagina die via HTTPS wordt aangeboden en waarop IndexedDB en `crypto.randomUUID()` beschikbaar zijn. Bekijk de meldingen in de browserconsole. De tweede `add()` probeert dezelfde sleutel te gebruiken. De handler voorkomt de standaardafbreking alleen bij de verwachte `ConstraintError`, zodat de eerste schrijfbewerking kan worden vastgelegd. Na afloop van de transactie sluit de code de verbinding en vraagt hij om verwijdering van de testdatabase.
Gerelateerde lessen
- JavaScript · Les 20 · Gemiddeld · Versie: 3
- JavaScript · Les 21 · Gemiddeld · Versie: 3
Bronnen
- 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