Expand JavaScript/node.js driver page a bit#546
Conversation
WalkthroughDocumentation guidance is added to the JavaScript connection documentation, introducing a Driver options section that recommends node-postgres for PostgreSQL-wire compatibility and node-crate for HTTP/REST features or when facing wire protocol limitations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/connect/javascript/_driver_options.md`:
- Around line 4-11: Reorder the driver list so `node-postgres` appears first and
`node-crate` second, and update the explanatory paragraph to prefer
`node-postgres` for PostgreSQL-wire (PG) compatibility with `node-crate` as the
HTTP/REST fallback; remove the phrase about being "actively maintained" and
instead state the protocol-based rationale (PG-wire vs HTTP/HTTPS) succinctly,
ensuring references to the driver names `node-postgres` and `node-crate` are
preserved.
Co-authored-by: Andreas Motl <andreas.motl@crate.io>
bmunkholm
left a comment
There was a problem hiding this comment.
What's the point with the include file? Are we going to reuse this somewhere else as well? If not, then just move it to the index file.
About
Closes https://github.com/crate/tech-content/issues/182
Preview
https://cratedb-guide--546.org.readthedocs.build/connect/javascript/