Skip to content

docs(postgrest): hide methods that should not show in the docs #1916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
laurenceisla wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −6
Draft

docs(postgrest): hide methods that should not show in the docs #1916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/core/postgrest-js/src/PostgrestBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ export default abstract class PostgrestBuilder<
protected fetch: Fetch
protected isMaybeSingle: boolean

/**
/** @hidden
*
* Creates a builder configured for a specific PostgREST request.
*
* @example
Expand Down
3 changes: 2 additions & 1 deletion packages/core/postgrest-js/src/PostgrestClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ import PostgrestFilterBuilder from './PostgrestFilterBuilder'
import { Fetch, GenericSchema, ClientServerOptions } from './types/common/common'
import { GetRpcFunctionFilterBuilderByArgs } from './types/common/rpc'

/**
/** @hidden
*
* PostgREST client.
*
* @typeParam Database - Types for the schema from the [type
Expand Down
3 changes: 2 additions & 1 deletion packages/core/postgrest-js/src/PostgrestError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ export default class PostgrestError extends Error {
hint: string
code: string

/**
/** @hidden
*
* @example
* ```ts
* import PostgrestError from '@supabase/postgrest-js'
Expand Down
6 changes: 3 additions & 3 deletions packages/core/postgrest-js/src/PostgrestQueryBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ export default class PostgrestQueryBuilder<
signal?: AbortSignal
fetch?: Fetch

/**
/** @hidden
*
* Creates a query builder scoped to a Postgres table or view.
*
* @example
Expand Down Expand Up @@ -265,7 +266,7 @@ export default class PostgrestQueryBuilder<
Relationships,
'POST'
>
/**
/**
* Perform an UPSERT on the table or view. Depending on the column(s) passed
* to `onConflict`, `.upsert()` allows you to perform the equivalent of
* `.insert()` if a row with the corresponding `onConflict` columns doesn't
Expand Down Expand Up @@ -351,7 +352,6 @@ export default class PostgrestQueryBuilder<
* ```
*/


upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
values: Row | Row[],
{
Expand Down
1 change: 1 addition & 0 deletions packages/core/postgrest-js/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export {
PostgrestBuilder,
PostgrestError,
}
/** @hidden */
export default {
PostgrestClient,
PostgrestQueryBuilder,
Expand Down
Loading