Registry / database / sqlite-wasm-viewer

sqlite-wasm-viewer

library1.2.0jsnpmunverified

Browser-based SQLite OPFS viewer for @sqlite.org/sqlite-wasm (peer dep v3.x). Provides a UI to inspect OPFS-backed databases, run arbitrary SQL queries, and filter tables. The only dedicated OPFS viewer for sqlite-wasm as of v1.2.0, actively maintained with monthly releases. Differentiators: zero server-side code, works offline via Service Worker, and supports persistent storage via OPFS.

database

npm install sqlite-wasm-viewer

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQLITE-WASM-VIEWER

sqlite-wasm-viewer

databasejavascriptv1.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SqliteWasmViewer

✓ import { SqliteWasmViewer } from 'sqlite-wasm-viewer'

✗ const SqliteWasmViewer = require('sqlite-wasm-viewer')

ESM-only package; CJS require will fail

default

✓ import SqliteWasmViewer from 'sqlite-wasm-viewer'

✗ import { default } from 'sqlite-wasm-viewer'

Default export can be imported as named or default

DatabaseViewer

✓ import { DatabaseViewer } from 'sqlite-wasm-viewer'

Named export for lower-level access; also ESM-only

Initializes sqlite-wasm, creates a viewer instance, opens an OPFS database, and runs a sample SQL query.

import { SqliteWasmViewer } from 'sqlite-wasm-viewer'; import sqlite3InitModule from '@sqlite.org/sqlite-wasm'; async function main() { const sqlite3 = await sqlite3InitModule(); const viewer = new SqliteWasmViewer(sqlite3); await viewer.open('my-db.sqlite3'); const result = viewer.query('SELECT * FROM users LIMIT 5'); console.log(result); } main();

Debug

Known issues

gotchaPackage is ESM-only; using require() throws Module is not defined.

fix

Use import syntax or dynamic import().

affects: >=1.0.0

gotchaRequires @sqlite.org/sqlite-wasm v3.x as a peer dependency; mismatched versions cause runtime errors.

fix

Ensure @sqlite.org/sqlite-wasm is at ^3.0.0 in package.json.

affects: >=1.0.0

gotchaDatabase file must be stored in OPFS; regular IndexedDB or localStorage paths fail silently.

fix

Open databases via the viewer's open method with an OPFS-compatible name.

affects: >=1.0.0

deprecatedMethod 'filterTable' is deprecated in v1.1.0; replaced by 'filter'.

fix

Use viewer.filter(tableName, condition) instead.

affects: >=1.1.0 <1.2.0

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'open')

sqlite3 instance not initialized or passed incorrectly.

fix

Ensure sqlite3InitModule() resolves and the result is passed to new SqliteWasmViewer(sqlite3).

Module not found: Error: Can't resolve 'sqlite-wasm-viewer'

Package not installed or missing from dependencies.

fix

Run npm install sqlite-wasm-viewer @sqlite.org/sqlite-wasm.

TypeError: viewer.open is not a function

Using default import with wrong symbol; e.g., import { open } instead of viewer.open.

fix

Use the viewer instance method: await viewer.open('mydb.sqlite3').

Upgrade

Version history

1.2.0latest on npm

Audit

Dependencies

@sqlite.org/sqlite-wasmrequiredCore dependency for SQLite WebAssembly operations

Agent activity

18 hits · last 30 days

node