From aedae81c7506b7b162a2b5ed0e41c46b2265a017 Mon Sep 17 00:00:00 2001 From: Jakob Runge Date: Fri, 15 Mar 2024 06:54:57 +0100 Subject: [PATCH] Fix broken link in docs (#3155) * Fix broken link to /apis/types in docs * Adjust slugs in docs pages --- docs/pages/apis/cursor.mdx | 2 +- docs/pages/apis/result.mdx | 2 +- docs/pages/apis/types.mdx | 2 +- docs/pages/features/queries.mdx | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/pages/apis/cursor.mdx b/docs/pages/apis/cursor.mdx index 286e9ca5..eadde4bf 100644 --- a/docs/pages/apis/cursor.mdx +++ b/docs/pages/apis/cursor.mdx @@ -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. diff --git a/docs/pages/apis/result.mdx b/docs/pages/apis/result.mdx index 62888f11..314d5049 100644 --- a/docs/pages/apis/result.mdx +++ b/docs/pages/apis/result.mdx @@ -1,6 +1,6 @@ --- title: pg.Result -slug: /api/result +slug: /apis/result --- The `pg.Result` shape is returned for every successful query. diff --git a/docs/pages/apis/types.mdx b/docs/pages/apis/types.mdx index 55f3b000..cc8e4c1e 100644 --- a/docs/pages/apis/types.mdx +++ b/docs/pages/apis/types.mdx @@ -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). diff --git a/docs/pages/features/queries.mdx b/docs/pages/features/queries.mdx index a2f6c6a5..2ecbaca1 100644 --- a/docs/pages/features/queries.mdx +++ b/docs/pages/features/queries.mdx @@ -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 = {