Make async/await the primary examples in the docs
#2932
Conversation
|
Hey sorry for missing this here - is this all ready for review? I'm a bit confused as why CF didnt' deploy a new preview version of the docs to check out live....if it's ready for final pass wanna merge |
Heya! No prob. Easy to have things slip through the cracks on gh 👍🏻 This should all be ready for review. I'll try updating master from upstream to cause CF to try the auto-rebuild 👍🏻 |
|
@brianc Looks like you have to manually "Approve" the workflow as I'm a new contributor 🙂 Hopefully that unblocks CF 🚀 |
|
nice! Turned it on. :) yeah hopefully this works... 🤞 |
|
didn't work! NICE!!!! I'll just review it manually :) |
Yay for automation! 🙈 I'm assuming CF has a similar protection as Netlify does in that it doesn't auto-build previews from strangers to prevent me from DoSing your resources or bill 🙃 |
| @@ -116,7 +116,7 @@ [email protected] | |||
| To demonstrate the issue & see if you are vunerable execute the following in node: | |||
|
|
|||
| ```js | |||
| const { Client } = require('pg') | |||
| import { Client } from 'pg' | |||
There was a problem hiding this comment.
I also updated the examples to use [ESM] instead of [CJS].
This doesn’t work, see #2534.
| await client.connect() | ||
|
|
||
| try { | ||
| const res = await client.query('SELECT $1::text as message', ['Hello world!']) |
There was a problem hiding this comment.
3-space indents and a semicolon appear after this point
There was a problem hiding this comment.
Hooray for my VS Code settings bleeding through due to the lack of an .editorconfig 😬 I'll tweak it 👍🏻
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
Co-authored-by: Charmander <[email protected]>
|
Welp the preview still isn't updating. I'll merge this and fix anything else myself I see wrong throughout the day today. Thanks for all the work and review effort involved here. ❤️ |
|
Appreciate it @brianc! I had this PR bookmarked to revisit, but haven't found the time to dive deep in the ESM import point @charmander pointed out above. Happy to open another PR revising that if you already have the information available on what those imports should look like (and/or how to make those named exports work as expected in node-pg in the first place!) 🙂 |
|
yeah I'll just change it to `const { Client } = require('pg')` - I think
that works. I only use typescript these days so i'll have to dust off some
vanilla js and try it before I confirm but easy fix either way.
…On Wed, May 31, 2023 at 11:27 AM Rijk van Zanten ***@***.***> wrote:
Appreciate it @brianc <https://github.com/brianc>! I had this PR
bookmarked to revisit, but haven't found the time to dive deep in the ESM
import point @charmander <https://github.com/charmander> pointed out
above. Happy to open another PR revising that if you already have the
information available on what those imports should look like (and/or how to
make those named exports work as expected in node-pg in the first place!)
🙂
—
Reply to this email directly, view it on GitHub
<#2932 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAMHIKX6SHI4USLKCL56L3XI5WOZANCNFSM6AAAAAAV5PLSDM>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
* Correctly capitalize GitHub * Add note on callbacks to index * Add note on error handling * Update client examples to use promises * Update pooling examples * Fix readme link * Update cursor docs * Update connecting examples * Update Queries * Update examples in pooling * Update trx examples * Update SSL example * Update example * Use ESM instead of CJS * Update docs/pages/apis/cursor.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/apis/cursor.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/apis/pool.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/apis/pool.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/apis/pool.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/features/connecting.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/features/connecting.mdx Co-authored-by: Charmander <[email protected]> * Update docs/pages/features/ssl.mdx Co-authored-by: Charmander <[email protected]> --------- Co-authored-by: Charmander <[email protected]>
Updated all the examples in the docs to use async/await. Callbacks are mentioned as an availability in the main index, but are omitted from the examples to simplify the overall use.
I also updated the examples to use CJS instead of ESM. This is still a bit of a touchy subject in NodeJS land, so no hard feelings if we want to revert that particular commit (fcd53f9)
Closes #2855