CKTIS / JavaScript
IDBRequest: резултат и грешка на заявка
Научете кога да четете `result` и `error` в IndexedDB и как да различавате успеха на отделна заявка от потвърждаването на транзакцията.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
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 и error са две свойства само за четене на обект IDBRequest. Заявката в IndexedDB представлява асинхронна операция. Тя не е Promise, затова await request не изчаква приключването на операцията. IndexedDB е интерфейс на уеб платформата, а не част от ECMAScript 2024. Наличността му зависи от средата за изпълнение.
Докато request.readyState е "pending", четенето на което и да е от двете свойства предизвиква изключение DOMException с име InvalidStateError. Състоянието "done" само по себе си не означава успех. Обикновено резултатът се чете в обработчика на събитието success. Изключение: в обработчика на upgradeneeded за заявка от indexedDB.open() свойството result вече е достъпно за промени по схемата, въпреки че крайното събитие success още не е настъпило.
При success стойността на error е null, а result зависи от операцията: open() предоставя връзка IDBDatabase, add() дава ключа на записания запис, а get() може да даде undefined, ако няма запис с този ключ. При error стойността на result е undefined, а error съдържа DOMException. Проверете request.error.name, за да разпознаете грешка като ConstraintError. Само по себе си undefined не означава неуспех. try...catch около извикването на API улавя синхронни изключения, но не и грешки, съобщени по-късно чрез събитие error.
Успешната заявка за запис не означава, че транзакцията е потвърдена. Следете за complete, за да потвърдите успешното приключване на транзакцията, и за abort, за да установите отмяна на промените. По подразбиране грешка в заявка в рамките на транзакция прекратява транзакцията. Ако грешката е очаквана и може да се обработи безопасно, извикайте event.preventDefault() в обработчика на error на заявката. Това предотвратява прекратяването по подразбиране, но не превръща неуспешната заявка в успешна.
Примери
<!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>Резултат
first: result=1, error=null second: result=undefined, error=ConstraintError transaction: complete
Отворете примера като HTML страница през HTTPS, на която са достъпни IndexedDB и `crypto.randomUUID()`. Проверете съобщенията в конзолата на браузъра. Второто извикване на `add()` се опитва да използва същия ключ. Обработчикът предотвратява прекратяването по подразбиране само при очаквания `ConstraintError`, така че първият запис може да бъде потвърден. След приключване на транзакцията кодът затваря връзката и заявява изтриване на тестовата база данни.
Свързани уроци
- JavaScript · Урок 20 · Средно · Версия: 3
- JavaScript · Урок 21 · Средно · Версия: 3
Източници
- 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