Skip to content

Commit

Permalink
Fix broken link in docs (#3155)
Browse files Browse the repository at this point in the history
* Fix broken link to /apis/types in docs

* Adjust slugs in docs pages
  • Loading branch information
runjak authored Mar 15, 2024
1 parent 641ab43 commit aedae81
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/pages/apis/cursor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: pg.Cursor
slug: /api/cursor
slug: /apis/cursor
---

A cursor can be used to efficiently read through large result sets without loading the entire result-set into memory ahead of time. It's useful to simulate a 'streaming' style read of data, or exit early from a large result set. The cursor is passed to `client.query` and is dispatched internally in a way very similar to how normal queries are sent, but the API it presents for consuming the result set is different.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/apis/result.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: pg.Result
slug: /api/result
slug: /apis/result
---

The `pg.Result` shape is returned for every successful query.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/apis/types.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Types
slug: /api/types
slug: /apis/types
---

These docs are incomplete, for now please reference [pg-types docs](https://github.com/brianc/node-pg-types).
2 changes: 1 addition & 1 deletion docs/pages/features/queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ console.log(res.rows[0]) // ['Brian', 'Carlson']

### Types

You can pass in a custom set of type parsers to use when parsing the results of a particular query. The `types` property must conform to the [Types](/api/types) API. Here is an example in which every value is returned as a string:
You can pass in a custom set of type parsers to use when parsing the results of a particular query. The `types` property must conform to the [Types](/apis/types) API. Here is an example in which every value is returned as a string:

```js
const query = {
Expand Down

0 comments on commit aedae81

Please sign in to comment.