@supabase/postgrest-js 3.0.0-next.21 → 3.0.0-next.22

package/dist/index.mjs

@@ -166,6 +166,7 @@ var PostgrestBuilder = class {
 	* {@link https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls}
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -434,6 +435,7 @@ var PostgrestBuilder = class {
 	* @returns A PostgrestBuilder instance with the new type
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example Complete Override type of successful response
 	* ```ts
@@ -489,7 +491,7 @@ var PostgrestBuilder = class {
 	* let x: typeof data // CountryRowProperties & { status: "A" | "B" } | null
 	* ```
 	*
-	* @example Example 5
+	* @example Merge vs replace existing types
 	* ```typescript
 	* // Merge with existing types (default behavior)
 	* const query = supabase
@@ -522,6 +524,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @param columns - The columns to retrieve, separated by commas
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `upsert()`
 	* ```ts
@@ -586,6 +589,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -772,6 +776,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -881,6 +886,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -932,6 +938,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @param signal - The AbortSignal to use for the fetch request
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @remarks
 	* You can use this to set a timeout for the request.
@@ -1002,6 +1009,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1047,6 +1055,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* this returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1086,6 +1095,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* Return `data` as a string in CSV format.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @exampleDescription Return data as CSV
 	* By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.
@@ -1159,6 +1169,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* or `"json"`
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @exampleDescription Get the execution plan
 	* By default, the data is returned in TEXT format, but can also be returned as JSON by using the `format` parameter.
@@ -1260,6 +1271,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @deprecated Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @remarks
 	* - Deprecated: use overrideTypes method instead
@@ -1322,6 +1334,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1369,6 +1382,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1420,6 +1434,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* When using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need
@@ -1471,6 +1486,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1522,6 +1538,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1569,6 +1586,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1620,6 +1638,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1667,6 +1686,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param patterns - The patterns to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*/
 	likeAllOf(column, patterns) {
 		this.url.searchParams.append(column, `like(all).{${patterns.join(",")}}`);
@@ -1679,6 +1699,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param patterns - The patterns to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*/
 	likeAnyOf(column, patterns) {
 		this.url.searchParams.append(column, `like(any).{${patterns.join(",")}}`);
@@ -1691,6 +1712,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1738,6 +1760,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param patterns - The patterns to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*/
 	ilikeAllOf(column, patterns) {
 		this.url.searchParams.append(column, `ilike(all).{${patterns.join(",")}}`);
@@ -1750,6 +1773,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param patterns - The patterns to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*/
 	ilikeAnyOf(column, patterns) {
 		this.url.searchParams.append(column, `ilike(any).{${patterns.join(",")}}`);
@@ -1790,6 +1814,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription Checking for nullness, true or false
 	* Using the `eq()` filter doesn't work when filtering for `null`.
@@ -1855,6 +1880,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param values - The values array to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1925,6 +1951,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The jsonb, array, or range value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example On array columns
 	* ```ts
@@ -2059,6 +2086,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The jsonb, array, or range value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example On array columns
 	* ```ts
@@ -2194,6 +2222,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param range - The range to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* Postgres supports a number of [range
@@ -2254,6 +2283,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param range - The range to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* Postgres supports a number of [range
@@ -2313,6 +2343,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param range - The range to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* Postgres supports a number of [range
@@ -2372,6 +2403,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param range - The range to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* Postgres supports a number of [range
@@ -2432,6 +2464,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param range - The range to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @exampleDescription With `select()`
 	* Postgres supports a number of [range
@@ -2490,6 +2523,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The array or range value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example On array columns
 	* ```ts
@@ -2589,6 +2623,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param options.type - Change how the `query` text is interpreted
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @remarks
 	* - For more information, see [Postgres full text search](/docs/guides/database/full-text-search).
@@ -2698,6 +2733,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* to their filter values
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -2753,6 +2789,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with, following PostgREST syntax
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @remarks
 	* not() expects you to use the raw PostgREST syntax for the filter values.
@@ -2817,6 +2854,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param options.foreignTable - Deprecated, use `referencedTable` instead
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @remarks
 	* or() expects you to use the raw PostgREST syntax for the filter names and values.
@@ -2970,6 +3008,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with, following PostgREST syntax
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @remarks
 	* filter() expects you to use the raw PostgREST syntax for the filter values.