Repository navigation
docs(readme): fix browser example to use the BrowserDb API - #6
Merged
Merged
Conversation
The browser quick start used MiniGrafDb.inMemory() with a synchronous execute(), which is the Node binding's API. @minigraf/browser exports BrowserDb with async open()/openInMemory() and a Promise-returning execute(). Also document execute()'s JSON shapes, exportGraph(), importGraph() and checkpoint(). Fixes #5 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NKBfvFi6GCQzi635H2ueqk
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #5.
The browser quick start in the README used
MiniGrafDb.inMemory()with a synchronousexecute(). That is the API of the Node binding (minigrafon npm), not of@minigraf/browser.Changes
await BrowserDb.open('mydb'), notesBrowserDb.openInMemory()for tests, and awaitsexecute().execute()returns.open,openInMemory,exportGraph,importGraphandcheckpoint.minigraffor server-side use.Checked against the
BrowserDbbindings in theminigraf2.0.6 crate (src/browser/mod.rs), which is the version pinned inCargo.toml. The example itself was not run.🤖 Generated with Claude Code
https://claude.ai/code/session_01NKBfvFi6GCQzi635H2ueqk