@supabase/postgrest-js 2.105.2-canary.3 → 2.105.2

package/dist/index.cjs

@@ -162,6 +162,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
@@ -430,6 +431,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
@@ -485,7 +487,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
@@ -518,6 +520,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @param columns - The columns to retrieve, separated by commas
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `upsert()`
 	* ```ts
@@ -582,6 +585,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -768,6 +772,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -877,6 +882,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -928,6 +934,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.
@@ -998,6 +1005,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1043,6 +1051,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* this returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1082,6 +1091,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.
@@ -1155,6 +1165,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.
@@ -1256,6 +1267,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
@@ -1318,6 +1330,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1365,6 +1378,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1416,6 +1430,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
@@ -1467,6 +1482,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1518,6 +1534,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1565,6 +1582,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1616,6 +1634,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1663,6 +1682,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(",")}}`);
@@ -1675,6 +1695,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(",")}}`);
@@ -1687,6 +1708,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1734,6 +1756,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(",")}}`);
@@ -1746,6 +1769,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(",")}}`);
@@ -1786,6 +1810,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`.
@@ -1851,6 +1876,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param values - The values array to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1921,6 +1947,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
@@ -2055,6 +2082,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
@@ -2190,6 +2218,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
@@ -2250,6 +2279,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
@@ -2309,6 +2339,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
@@ -2368,6 +2399,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
@@ -2428,6 +2460,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
@@ -2486,6 +2519,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
@@ -2585,6 +2619,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).
@@ -2694,6 +2729,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* to their filter values
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -2749,6 +2785,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.
@@ -2813,6 +2850,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.
@@ -2966,6 +3004,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.