Repository navigation
README browser example uses MiniGrafDb.inMemory(), but @minigraf/browser exports BrowserDb #5
Description
The browser quick start in README.md doesn't match the API that @minigraf/browser 2.0.4 exports.
README shows:
import init, { MiniGrafDb } from '@minigraf/browser'
await init()
const db = MiniGrafDb.inMemory()
db.execute('(transact [[:alice :name "Alice"]])')
const result = JSON.parse(db.execute('(query [:find ?n :where [?e :name ?n]])'))The package actually exports (from minigraf_wasm.d.ts in 2.0.4):
BrowserDb, notMiniGrafDbBrowserDb.open(dbName)(IndexedDB-backed, returns aPromise<BrowserDb>)BrowserDb.openInMemory()(notinMemory())execute()returns aPromise<string>, so it needsawait
MiniGrafDb with inMemory() and a synchronous execute() is the Node binding's API (minigraf on npm), so the example looks copied from there.
Suggested example:
import init, { BrowserDb } from '@minigraf/browser'
await init()
const db = await BrowserDb.open('mydb') // or BrowserDb.openInMemory() for tests
await db.execute('(transact [[:alice :name "Alice"]])')
const result = JSON.parse(await db.execute('(query [:find ?n :where [?e :name ?n]])'))
console.log(result.results[0][0]) // "Alice"It may also be worth mentioning exportGraph() / importGraph() and checkpoint(), which the README doesn't cover.
Checked against: @minigraf/browser@2.0.4 from npm. I confirmed BrowserDb.openInMemory() and await db.execute(...) work by loading the package with initSync in Node 24. minigraf-playground/lib/wasm-loader.ts also uses BrowserDb.open.
Activity