21 Commits

Author SHA1 Message Date
Matthew Richmond
0ee010e5a0
Update project-structure.md (#3166)
Small path update
2024-03-13 12:42:59 -05:00
Akash
2a8efbee09
Minor typo correction (#3135) 2024-02-09 21:27:50 -08:00
FB
6cd0aeb212
Uppercase LTS in docs home page (#3103)
Changed 'lts' to 'LTS' for better readability, so people get it stands for Long-Term-Support
2023-11-29 22:52:36 -08:00
Kyle Gray
a733b40f99
docs: Link to current PostgreSQL data types page (#3097)
The data types link pointed at PostgreSQL 9.5. Update the link to always point to the latest version of PostgreSQL.
2023-11-19 17:05:44 -06:00
Alex Anderson
16322c2d50
Fix eslint violations (#3078)
Co-authored-by: alxndrsn <alxndrsn>
2023-10-19 10:27:25 -05:00
Riku Rauhala
970804b6c1
Update pg-connection-string url in connecting.mdx (#3005) 2023-07-07 17:47:35 -05:00
Arian Mirahmadi
735683c5cb
Fix typo in project-structure.md (#3008) 2023-06-13 14:22:04 -07:00
Filipe Correa
46cfb25baf
Remove await from client release (#3006)
Co-authored-by: Filipe Correa <f.avelino-correa@klarna.com>
2023-06-12 12:50:40 -07:00
Jason Ford
4dbf1af069
Add note about case sensitivity of result of pg.escapeIdentifier (#2993) 2023-06-01 01:03:50 -05:00
Rijk van Zanten
20d2c08027
Make async/await the primary examples in the docs (#2932)
* 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 <~@charmander.me>

* Update docs/pages/apis/cursor.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/apis/pool.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/apis/pool.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/apis/pool.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/features/connecting.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/features/connecting.mdx

Co-authored-by: Charmander <~@charmander.me>

* Update docs/pages/features/ssl.mdx

Co-authored-by: Charmander <~@charmander.me>

---------

Co-authored-by: Charmander <~@charmander.me>
2023-05-31 11:25:24 -05:00
Shane
65406985b9
Fix typo in types.mdx (#2989) 2023-05-29 12:07:05 -07:00
Conner
249182ea9f
Document client.escapeIdentifier and client.escapeLiteral (#2954)
* Document client.escapeIdentifier and client.escapeLiteral

Per #1978 it seems that these client APIs are undocumented. Added documentation for these functions along with some examples and relevant links.

* Fix typos in new docs

* Migrate escapeIdentifier and escapeLiteral from Client to PG

These are standalone utility functions, they do not need a client instance to function.

Changes made:
- Refactored escapeIdentifer and escapeLiteral from client class to functions in utils
- Update PG to export  escapeIdentifier and escapeLiteral
- Migrated tests for Client.escapeIdentifier and Client.escapeLiteral to tests for utils
- Updated documentation, added a "utilities" page where these helpers are discussed

**note** this is a breaking change. Users who used these functions (previously undocumented) on instances of Client, or via Client.prototype.

* Export escapeIdentifier and escapeLiteral from PG

These are standalone utility functions, they should not depend on a client instance.

Changes made:
- Refactored escapeIdentifer and escapeLiteral from client class to functions in utils
- Re-exported functions on client for backwards compatibility
- Update PG to export  escapeIdentifier and escapeLiteral
- Updated tests to validate the newly exported functions from both entry points
- Updated documentation, added a "utilities" page where these helpers are discussed

* Ensure escape functions work via Client.prototype

Updated changes such that escapeIdentifier and escapeLiteral are usable via the client prototype
Updated tests to check for both entry points in client
2023-05-02 07:55:59 -05:00
Felix Rath
d63c761be8
docs(api/result): clarify that result.rowCount can be null (#2967)
`result.rowCount` is initialized to `null`, but only set to an `int`-value if the returned command tag consists of more than one word, which is not the case in general.

For example, the `LOCK` command will return a command tag of simply the form `LOCK`, and thus `result.rowCount` will stay `null`.
2023-05-01 09:15:55 -05:00
Jan Piotrowski
b357e1884a
fix(theme.config.js): Replace default meta description and social title (#2952)
Currently still nextra default.

Those are shown in Slack and other social apps when sharing the website.
2023-04-20 16:03:59 +02:00
Samuel Durante
92351b5f3e
docs(client): improve the Client instance example (#2935) 2023-03-30 10:49:28 -05:00
Ryan B. Harvey
65ca2458fd
Add release event to Pool API docs (#2928) 2023-03-16 11:34:50 -05:00
Aram Zegerius
8804e5caaf
Fix typo in URL (#2913) 2023-03-06 12:30:37 -06:00
Meron Ogbai
3e34816f6f
Update title (#2886)
This will change the title of the docs from Next.js Static Site Generator to node-postgres
2022-12-30 22:45:42 -06:00
Brian C
27d612a2ac
Update docs (#2867)
- fix config warnings
- add search bar
- add google analytics
2022-11-23 21:50:36 -06:00
Brian C
12b9a69776
update docs - clean up interface (#2863)
* update docs - clean up interface

* Remove node v8.x from test matrix
2022-11-23 15:08:09 -06:00
Brian C
1aa08274a5
Migrate docs repo into monorepo (#2823)
* Move files over

* Finish initial port of content
2022-10-10 12:20:46 -05:00