-
Notifications
You must be signed in to change notification settings - Fork 460
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.
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
(docs) Add "Node.js and Materialize" guide #7543
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, Andy --
This looks really good! My suggestions are mostly focused on moving information to an introduction before the code instead of interspersing it or putting it below.
@msudberg I merged after getting a thumbs-up from Petros, but will integrate your feedback into an update. |
This guide centralizes and links out to all the reference content necessary for using Node.js with Materialize.
Why: Help developers who are building Node.js applications that interact with Materialize understand how to communicate with Materialize, which concepts (like TAIL and FETCH) to investigate further, and give them some barebones examples to get up and running with a Node.js app and Materialize.
Where more detail may be necessary:
pg-cursor
and the node.jsstreams
API, but I left this out of the guide because it felt like too much of a leap in complexity from the basic examples provided throughout the rest of the guide. I think we can create either a demo page or a separate article walking through Petros' example.pg-query-stream
because it won't be ready until Petros' PR to the external repo is merged: pg-query-stream: make rows available as soon as possible brianc/node-postgres#2573