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

package/dist/index.cjs

@@ -168,6 +168,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
@@ -436,6 +437,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
@@ -491,7 +493,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
@@ -524,6 +526,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @param columns - The columns to retrieve, separated by commas
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `upsert()`
 	* ```ts
@@ -588,6 +591,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -774,6 +778,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -883,6 +888,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -934,6 +940,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.
@@ -1004,6 +1011,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1049,6 +1057,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* this returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1088,6 +1097,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.
@@ -1161,6 +1171,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.
@@ -1262,6 +1273,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
@@ -1324,6 +1336,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1371,6 +1384,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1422,6 +1436,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
@@ -1473,6 +1488,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1524,6 +1540,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1571,6 +1588,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1622,6 +1640,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1669,6 +1688,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(",")}}`);
@@ -1681,6 +1701,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(",")}}`);
@@ -1693,6 +1714,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1740,6 +1762,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(",")}}`);
@@ -1752,6 +1775,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(",")}}`);
@@ -1792,6 +1816,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`.
@@ -1857,6 +1882,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param values - The values array to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1927,6 +1953,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
@@ -2061,6 +2088,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
@@ -2196,6 +2224,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
@@ -2256,6 +2285,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
@@ -2315,6 +2345,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
@@ -2374,6 +2405,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
@@ -2434,6 +2466,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
@@ -2492,6 +2525,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
@@ -2591,6 +2625,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).
@@ -2700,6 +2735,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* to their filter values
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -2755,6 +2791,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.
@@ -2819,6 +2856,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.
@@ -2972,6 +3010,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.