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

package/dist/index.mjs

@@ -160,6 +160,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
@@ -428,6 +429,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
@@ -483,7 +485,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
@@ -516,6 +518,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* @param columns - The columns to retrieve, separated by commas
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `upsert()`
 	* ```ts
@@ -580,6 +583,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -766,6 +770,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -875,6 +880,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* instead
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -926,6 +932,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.
@@ -996,6 +1003,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1041,6 +1049,7 @@ var PostgrestTransformBuilder = class extends PostgrestBuilder {
 	* this returns an error.
 	*
 	* @category Database
+	* @subcategory Using modifiers
 	*
 	* @example With `select()`
 	* ```ts
@@ -1080,6 +1089,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.
@@ -1153,6 +1163,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.
@@ -1254,6 +1265,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
@@ -1316,6 +1328,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1363,6 +1376,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1414,6 +1428,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
@@ -1465,6 +1480,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1516,6 +1532,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1563,6 +1580,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param value - The value to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1614,6 +1632,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1661,6 +1680,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(",")}}`);
@@ -1673,6 +1693,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(",")}}`);
@@ -1685,6 +1706,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param pattern - The pattern to match with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1732,6 +1754,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(",")}}`);
@@ -1744,6 +1767,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(",")}}`);
@@ -1784,6 +1808,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`.
@@ -1849,6 +1874,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* @param values - The values array to filter with
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -1919,6 +1945,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
@@ -2053,6 +2080,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
@@ -2188,6 +2216,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
@@ -2248,6 +2277,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
@@ -2307,6 +2337,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
@@ -2366,6 +2397,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
@@ -2426,6 +2458,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
@@ -2484,6 +2517,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
@@ -2583,6 +2617,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).
@@ -2692,6 +2727,7 @@ var PostgrestFilterBuilder = class extends PostgrestTransformBuilder {
 	* to their filter values
 	*
 	* @category Database
+	* @subcategory Using filters
 	*
 	* @example With `select()`
 	* ```ts
@@ -2747,6 +2783,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.
@@ -2811,6 +2848,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.
@@ -2964,6 +3002,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.