@supabase/supabase-js 2.100.0-rc.0 → 2.100.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/supabase-js",
-  "version": "2.100.0-rc.0",
+  "version": "2.100.1",
   "description": "Isomorphic Javascript SDK for Supabase",
   "keywords": [
     "javascript",
@@ -57,7 +57,7 @@
     "test:unit": "jest --runInBand --detectOpenHandles test/unit",
     "test:coverage": "jest --runInBand --coverage --testPathIgnorePatterns=\"test/integration|test/deno\"",
     "test:integration": "jest --runInBand --detectOpenHandles test/integration.test.ts",
-    "test:integration:browser": "deno test --allow-all test/integration.browser.test.ts",
+    "test:integration:browser": "deno test --node-modules-dir=manual --allow-all test/integration.browser.test.ts",
     "test:edge-functions": "cd test/deno && npm run test:edge-functions",
     "test:deno": "cd test/deno && npm run test",
     "test:watch": "jest --watch --verbose false --silent false",
@@ -80,11 +80,11 @@
     "update:test-deps:bun": "cd test/integration/bun && bun install"
   },
   "dependencies": {
-    "@supabase/auth-js": "2.100.0-rc.0",
-    "@supabase/functions-js": "2.100.0-rc.0",
-    "@supabase/postgrest-js": "2.100.0-rc.0",
-    "@supabase/realtime-js": "2.100.0-rc.0",
-    "@supabase/storage-js": "2.100.0-rc.0"
+    "@supabase/auth-js": "2.100.1",
+    "@supabase/functions-js": "2.100.1",
+    "@supabase/postgrest-js": "2.100.1",
+    "@supabase/realtime-js": "2.100.1",
+    "@supabase/storage-js": "2.100.1"
   },
   "devDependencies": {
     "jsr": "^0.13.5",

package/src/SupabaseClient.ts

@@ -481,6 +481,13 @@ export default class SupabaseClient<
 
   /**
    * Returns all Realtime channels.
+   *
+   * @category Initializing
+   *
+   * @example Get all channels
+   * ```js
+   * const channels = supabase.getChannels()
+   * ```
    */
   getChannels(): RealtimeChannel[] {
     return this.realtime.getChannels()
@@ -491,6 +498,16 @@ export default class SupabaseClient<
    *
    * @param {RealtimeChannel} channel - The name of the Realtime channel.
    *
+   *
+   * @category Initializing
+   *
+   * @remarks
+   * - Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.
+   *
+   * @example Removes a channel
+   * ```js
+   * supabase.removeChannel(myChannel)
+   * ```
    */
   removeChannel(channel: RealtimeChannel): Promise<'ok' | 'timed out' | 'error'> {
     return this.realtime.removeChannel(channel)
@@ -498,6 +515,16 @@ export default class SupabaseClient<
 
   /**
    * Unsubscribes and removes all Realtime channels from Realtime client.
+   *
+   * @category Initializing
+   *
+   * @remarks
+   * - Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.
+   *
+   * @example Remove all channels
+   * ```js
+   * supabase.removeAllChannels()
+   * ```
    */
   removeAllChannels(): Promise<('ok' | 'timed out' | 'error')[]> {
     return this.realtime.removeAllChannels()

package/src/cors.ts

@@ -52,7 +52,7 @@ export type CorsHeaders = Record<string, string>
  * Includes all headers sent by Supabase client libraries and allows all standard HTTP methods.
  * Use this for simple CORS configurations with wildcard origin.
  *
- * @example
+ * @example Basic usage
  * ```typescript
  * import { corsHeaders } from '@supabase/supabase-js/cors'
  *

package/src/index.ts

@@ -30,7 +30,7 @@ export type {
 /**
  * Creates a new Supabase Client.
  *
- * @example
+ * @example Creating a Supabase client
  * ```ts
  * import { createClient } from '@supabase/supabase-js'
  *

package/src/lib/types.ts

@@ -35,7 +35,7 @@ export type SupabaseClientOptions<SchemaName> = {
      * Optional timeout in milliseconds for PostgREST requests.
      * When set, requests will automatically abort after this duration to prevent indefinite hangs.
      *
-     * @example
+     * @example With timeout
      * ```ts
      * const supabase = createClient(url, key, {
      *   db: { timeout: 30000 } // 30 second timeout
@@ -48,7 +48,7 @@ export type SupabaseClientOptions<SchemaName> = {
      * Defaults to 8000 characters. Used to provide helpful hints when URLs
      * exceed server limits.
      *
-     * @example
+     * @example With custom URL length limit
      * ```ts
      * const supabase = createClient(url, key, {
      *   db: { urlLengthLimit: 10000 } // Custom limit
@@ -82,7 +82,7 @@ export type SupabaseClientOptions<SchemaName> = {
      * also return access_token in the URL fragment, which would otherwise be incorrectly
      * intercepted by Supabase Auth.
      *
-     * @example
+     * @example With custom detection logic
      * ```ts
      * detectSessionInUrl: (url, params) => {
      *   // Ignore Facebook OAuth redirects
@@ -165,7 +165,7 @@ export type QueryError = PostgrestError
  * Strips internal Supabase metadata from Database types.
  * Useful for libraries defining generic constraints on Database types.
  *
- * @example
+ * @example Stripping internal Supabase metadata
  * ```typescript
  * type CleanDB = DatabaseWithoutInternals<Database>
  * ```

package/src/lib/version.ts

@@ -4,4 +4,4 @@
 // - Debugging and support (identifying which version is running)
 // - Telemetry and logging (version reporting in errors/analytics)
 // - Ensuring build artifacts match the published package version
-export const version = '2.100.0-rc.0'
+export const version = '2.100.1'