Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

IDBRequest — resultado de uma operação IndexedDB

IDBRequest expõe, através de eventos, o resultado ou o erro de uma operação IndexedDB assíncrona. O sucesso de um pedido ainda não significa que toda a transação tenha sido confirmada.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

request.result
request.error
request.onsuccess = (event) => { /* read request.result */ };
request.onerror = (event) => { /* read request.error */ };

IDBRequest é um objeto EventTarget devolvido por operações IndexedDB como get(). Não é uma Promise: usar apenas await request não espera pelo resultado. Faz parte das Web APIs, não de ECMAScript; a presença do Node 24 não prova que esta API esteja disponível no navegador.

IDBRequest.result contém um resultado específico da operação; após uma falha, devolve undefined. IDBRequest.error devolve uma DOMException após uma falha ou null após o sucesso. A leitura de qualquer uma destas propriedades quando readyState === "pending" gera InvalidStateError. Se get() não encontrar um registo, o pedido é bem-sucedido e o resultado é undefined; não se trata de um erro.

IDBRequest.onsuccess trata o evento success, e IDBRequest.onerror trata error. Por predefinição, um erro do pedido aborta a transação associada; atribuir um handler não altera este comportamento. O sucesso de um pedido não garante a confirmação: observa também os eventos complete e abort da transação.

O exemplo abre uma base de dados através de IDBOpenDBRequest, um subtipo de IDBRequest. A escrita e a leitura são colocadas em fila na mesma transação. Se get() for bem-sucedido, o respetivo handler onsuccess escreve request.result na consola antes de ser emitido o evento complete da transação, caso esse evento ocorra. A mensagem apresentada, IndexedDB unavailable: SecurityError, corresponde a um caso de erro em que não se chega à leitura.

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IDBRequest: operation success and transaction completion</title>
</head>
<body>
  <h1>Observing an IndexedDB request</h1>
  <script>
    (() => {
      const name = 'cktis-request-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
      const report = error => console.log(error.name === 'SecurityError'
        ? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
      let factory, opening;
      try {
        factory = window.indexedDB;
        if (!factory) {
          console.log('IndexedDB unavailable: API missing');
          return;
        }
        opening = factory.open(name, 1);
      } catch (error) {
        report(error);
        return;
      }
      let created = false;
      opening.onerror = () => report(opening.error);
      opening.onupgradeneeded = () => {
        created = true;
        opening.result.createObjectStore('values');
      };
      opening.onsuccess = () => {
        const db = opening.result;
        if (!created) {
          db.close();
          console.log('Fixture name already in use');
          return;
        }
        const tx = db.transaction('values', 'readwrite');
        const store = tx.objectStore('values');
        store.put('circle', 'shape');
        const request = store.get('shape');
        const cleanup = () => {
          db.close();
          factory.deleteDatabase(name);
        };
        console.log(`get before events: ${request.readyState}`);
        request.onsuccess = () => {
          console.log(`get success: ${request.readyState}, value: ${request.result}`);
        };
        request.onerror = () => console.log(`get error: ${request.error.name}`);
        tx.oncomplete = event => {
          console.log(`transaction: ${event.type}`);
          cleanup();
        };
        tx.onabort = event => {
          console.log(`transaction: ${event.type}`);
          cleanup();
        };
      };
    })();
  </script>
</body>
</html>

Resultado

IndexedDB unavailable: SecurityError

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes