8000 docs(readme): fix browser example to use the BrowserDb API by adityamukho · Pull Request #6 · project-minigraf/minigraf-wasm · GitHub
[go: up one dir, main page]
Skip to content

docs(readme): fix browser example to use the BrowserDb API #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityamukho merged 1 commit into from
Oct 14, 2026
Merged

docs(readme): fix browser example to use the BrowserDb API #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,36 @@ Two packages are published from this repo:
## Browser (`@minigraf/browser`)

```js
import init, { MiniGrafDb } from '@minigraf/browser'
import init, { BrowserDb } from '@minigraf/browser'

await init()

const db = MiniGrafDb.inMemory()
db.execute('(transact [[:alice :name "Alice"]])')
const db = await BrowserDb.open('mydb') // IndexedDB-backed; or BrowserDb.openInMemory() for tests
await db.execute('(transact [[:alice :name "Alice"]])')

const result = JSON.parse(db.execute('(query [:find ?n :where [?e :name ?n]])'))
const result = JSON.parse(await db.execute('(query [:find ?n :where [?e :name ?n]])'))
console.log(result.results[0][0]) // "Alice"
```

`execute()` returns a `Promise<string>` containing JSON:

- Query: `{"variables": [...], "results": [[...], ...]}`
- Transact: `{"transacted": <tx_id>}`
- Retract: `{"retracted": <tx_id>}`
- Rule: `{"ok": true}`

Other methods:

| Method | Description |
|--------|-------------|
| `BrowserDb.open(name)` | Open or create a database persisted in IndexedDB (async). |
| `BrowserDb.openInMemory()` | Open a non-persistent database. Data is lost when the page closes. |
| `db.exportGraph()` | Serialise the database to a `Uint8Array` that is byte-compatible with native `.graph` files. |
| `await db.importGraph(bytes)` | Replace the database with a `.graph` blob. The blob must be checkpointed, with no pending WAL sidecar. |
| `await db.checkpoint()` | Flush dirty pages to IndexedDB. You only need it after bulk operations; `execute()` already writes through. Does nothing on in-memory databases. |

`@minigraf/browser` does not run in Node.js. For server-side use, use [`minigraf`](https://www.npmjs.com/package/minigraf).

## WASI (`@minigraf/wasi`)

```js
Expand Down
Loading
0