Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

IDBRequest: výsledek, chyba a obsluha událostí

Po úspěchu požadavku IndexedDB čti `result`, po selhání `error`. Úspěch jednotlivého požadavku ještě neznamená, že byla potvrzena celá transakce.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

// 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 je objekt požadavku IndexedDB, nikoli příslib (Promise). IndexedDB je webové API, není součástí ECMAScript 2024 a jeho dostupnost závisí na běhovém prostředí. Dokud má readyState hodnotu "pending", čtení kterékoli z vlastností pouze pro čtení result a error vyvolá výjimku DOMException s názvem InvalidStateError. Ve stavu "done" lze tyto vlastnosti číst, ale tento stav neznamená, že požadavek uspěl. Požadavek IDBOpenDBRequest může být ve stavu "done" už během události upgradeneeded, ještě před závěrečnou událostí success nebo error.

Přiřaď funkce do request.onsuccess a request.onerror pro obsluhu událostí success a error v tomto pořadí. Nové přiřazení nahradí předchozí obslužnou funkci; pomocí addEventListener() lze přidat samostatné posluchače s názvem události bez on. Při úspěchu čti request.result: hodnota závisí na operaci. Například add() poskytne klíč přes result, zatímco get() může uspět s hodnotou undefined, pokud klíč neexistuje. Při úspěchu je request.error rovno null; při selhání obsahuje DOMException a request.result má hodnotu undefined. try...catch okolo volání může zachytit jeho synchronní výjimku, nikoli pozdější selhání požadavku.

Událost success se nešíří směrem vzhůru a nelze ji zrušit. U požadavku v transakci se error šíří směrem vzhůru a ve výchozím nastavení způsobí přerušení transakce. V obsluze očekávané chyby, ze které se lze zotavit, zavolej event.preventDefault(), abys tomuto výchozímu přerušení zabránil. Požadavek zůstane neúspěšný a událost se bude šířit dál.

Úspěšný požadavek na zápis neznamená potvrzení transakce. Další požadavky zadávej, dokud je transakce aktivní, například přímo v obsluze události požadavku. Na transakci sleduj událost complete pro potvrzení a abort pro vrácení změn.

Příklady

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

Výsledek

success: 1
error: ConstraintError
transaction: complete

Ulož příklad jako soubor HTML a zpřístupni jej přes HTTPS. Otevři stránku v prohlížeči, kde jsou dostupné IndexedDB a `crypto.randomUUID()`, a zkontroluj výstup ve vývojářské konzoli. První `add()` poskytne klíč `1` přes `result`; druhé selže s chybou `ConstraintError`. `preventDefault()` zabrání tomu, aby tato chyba přerušila transakci, takže může nastat `complete`. Po skončení transakce kód uzavře připojení a požádá o odstranění databáze vytvořené pro toto spuštění.

Související lekce

  • JavaScript · Lekce 31 · Pokročilá · Verze: 4

Zdroje