Notes about communicating with Dgraph via the browser #143
Conversation
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
|
Running Code Quality on PRs by uploading data to Trunk will soon be removed. You can still run checks on your PRs using trunk-action - see the migration guide for more information. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new “Browser support” section to the JavaScript SDK documentation, outlining how to interact with Dgraph via the HTTP API in browser environments and highlighting limitations and best practices.
- Introduces notes, tips, and warnings for browser usage of Dgraph
- Provides side-by-side code examples comparing Node.js gRPC and browser HTTP calls
- Adds a
parseDgraphUrlhelper and a summary of HTTP API limitations
Comments suppressed due to low confidence (3)
dgraph/sdks/javascript.mdx:560
- [nitpick] The variable name
pis ambiguous in this context; consider renaming it to something more descriptive (e.g.,personornewUser).
const p = { name: "Alice", age: 26 }
dgraph/sdks/javascript.mdx:434
- [nitpick] Consider adding a link to the official Dgraph HTTP API reference to help readers dive deeper into endpoint details and supported request formats.
the same capabilities in browsers using Dgraph's HTTP API with standard `fetch` requests.
dgraph/sdks/javascript.mdx:441
- [nitpick] You might want to mention the GraphQL endpoint path (e.g.,
/graphql) or include a link to the GraphQL API docs for clarity.
consider using Dgraph's GraphQL API instead, which is designed for client-side usage and provides better security boundaries.
johnymontana
approved these changes
May 30, 2025
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.
dgraph-js doesn't have official support for working in the browser, so here I added content to the JavaScript SDK doc that highlights this and proposes alternatives to the SDK usage.