Skip to content

Commit 0f39ae2

Browse files
committed
docs(postgrest): hide methods that should not show in the docs
1 parent 336e498 commit 0f39ae2

File tree

5 files changed

+10
-6
lines changed

5 files changed

+10
-6
lines changed

packages/core/postgrest-js/src/PostgrestBuilder.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ export default abstract class PostgrestBuilder<
2828
protected fetch: Fetch
2929
protected isMaybeSingle: boolean
3030

31-
/**
31+
/** @hidden
32+
*
3233
* Creates a builder configured for a specific PostgREST request.
3334
*
3435
* @example

packages/core/postgrest-js/src/PostgrestClient.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import PostgrestFilterBuilder from './PostgrestFilterBuilder'
33
import { Fetch, GenericSchema, ClientServerOptions } from './types/common/common'
44
import { GetRpcFunctionFilterBuilderByArgs } from './types/common/rpc'
55

6-
/**
6+
/** @hidden
7+
*
78
* PostgREST client.
89
*
910
* @typeParam Database - Types for the schema from the [type

packages/core/postgrest-js/src/PostgrestError.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ export default class PostgrestError extends Error {
88
hint: string
99
code: string
1010

11-
/**
11+
/** @hidden
12+
*
1213
* @example
1314
* ```ts
1415
* import PostgrestError from '@supabase/postgrest-js'

packages/core/postgrest-js/src/PostgrestQueryBuilder.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ export default class PostgrestQueryBuilder<
2121
signal?: AbortSignal
2222
fetch?: Fetch
2323

24-
/**
24+
/** @hidden
25+
*
2526
* Creates a query builder scoped to a Postgres table or view.
2627
*
2728
* @example
@@ -265,7 +266,7 @@ export default class PostgrestQueryBuilder<
265266
Relationships,
266267
'POST'
267268
>
268-
/**
269+
/**
269270
* Perform an UPSERT on the table or view. Depending on the column(s) passed
270271
* to `onConflict`, `.upsert()` allows you to perform the equivalent of
271272
* `.insert()` if a row with the corresponding `onConflict` columns doesn't
@@ -351,7 +352,6 @@ export default class PostgrestQueryBuilder<
351352
* ```
352353
*/
353354

354-
355355
upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
356356
values: Row | Row[],
357357
{

packages/core/postgrest-js/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export {
1414
PostgrestBuilder,
1515
PostgrestError,
1616
}
17+
/** @hidden */
1718
export default {
1819
PostgrestClient,
1920
PostgrestQueryBuilder,

0 commit comments

Comments
 (0)