@supabase/postgrest-js 2.104.0-canary.1 → 2.104.0

package/dist/index.cjs

@@ -103,25 +103,23 @@ var PostgrestBuilder = class {
 	/**
 	* Creates a builder configured for a specific PostgREST request.
 	*
-	* @example
+	* @example Using supabase-js (recommended)
 	* ```ts
-	* import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
+	* import { createClient } from '@supabase/supabase-js'
 	*
-	* const builder = new PostgrestQueryBuilder(
-	*   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-	*   { headers: new Headers({ apikey: 'public-anon-key' }) }
-	* )
+	* const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+	* const { data, error } = await supabase.from('users').select('*')
 	* ```
 	*
 	* @category Database
 	*
-	* @example Creating a Postgrest query builder
+	* @example Standalone import for bundle-sensitive environments
 	* ```ts
 	* import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
 	*
 	* const builder = new PostgrestQueryBuilder(
 	*   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-	*   { headers: new Headers({ apikey: 'public-anon-key' }) }
+	*   { headers: new Headers({ apikey: 'publishable-or-anon-key' }) }
 	* )
 	* ```
 	*/
@@ -3088,13 +3086,21 @@ var PostgrestQueryBuilder = class {
 	* @param options.urlLengthLimit - Maximum URL length before warning
 	* @param options.retry - Enable automatic retries for transient errors (default: true)
 	*
-	* @example Creating a Postgrest query builder
+	* @example Using supabase-js (recommended)
+	* ```ts
+	* import { createClient } from '@supabase/supabase-js'
+	*
+	* const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+	* const { data, error } = await supabase.from('users').select('*')
+	* ```
+	*
+	* @example Standalone import for bundle-sensitive environments
 	* ```ts
 	* import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
 	*
 	* const query = new PostgrestQueryBuilder(
 	*   new URL('https://xyzcompany.supabase.co/rest/v1/users'),
-	*   { headers: { apikey: 'public-anon-key' }, retry: true }
+	*   { headers: { apikey: 'publishable-or-anon-key' }, retry: true }
 	* )
 	* ```
 	*/
@@ -4668,15 +4674,12 @@ var PostgrestClient = class PostgrestClient {
 	*   When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network
 	*   errors or HTTP 503/520 responses will be automatically retried up to 3 times
 	*   with exponential backoff (1s, 2s, 4s). Defaults to `true`.
-	* @example
+	* @example Using supabase-js (recommended)
 	* ```ts
-	* import { PostgrestClient } from '@supabase/postgrest-js'
+	* import { createClient } from '@supabase/supabase-js'
 	*
-	* const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-	*   headers: { apikey: 'public-anon-key' },
-	*   schema: 'public',
-	*   timeout: 30000, // 30 second timeout
-	* })
+	* const supabase = createClient('https://xyzcompany.supabase.co', 'publishable-or-anon-key')
+	* const { data, error } = await supabase.from('profiles').select('*')
 	* ```
 	*
 	* @category Database
@@ -4685,25 +4688,14 @@ var PostgrestClient = class PostgrestClient {
 	* - A `timeout` option (in milliseconds) can be set to automatically abort requests that take too long.
 	* - A `urlLengthLimit` option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests.
 	*
-	* @example Creating a Postgrest client
-	* ```ts
-	* import { PostgrestClient } from '@supabase/postgrest-js'
-	*
-	* const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-	*   headers: { apikey: 'public-anon-key' },
-	*   schema: 'public',
-	* })
-	* ```
-	*
-	* @example With timeout
+	* @example Standalone import for bundle-sensitive environments
 	* ```ts
 	* import { PostgrestClient } from '@supabase/postgrest-js'
 	*
 	* const postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {
-	*   headers: { apikey: 'public-anon-key' },
+	*   headers: { apikey: 'publishable-or-anon-key' },
 	*   schema: 'public',
 	*   timeout: 30000, // 30 second timeout
-	*   retry: false, // Disable automatic retries
 	* })
 	* ```
 	*/