diff --git a/docs/v1/modules/lib_types.html b/docs/v1/modules/lib_types.html index 75687d2b5..57dc91f92 100644 --- a/docs/v1/modules/lib_types.html +++ b/docs/v1/modules/lib_types.html @@ -325,7 +325,7 @@
-

Automatically refreshes the token for logged in users.

+

Automatically refreshes the token for logged in users. Defaults to true.

@@ -359,7 +359,7 @@
-

Detect a session from the URL. Used for OAuth login callbacks.

+

Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.

@@ -440,7 +440,7 @@
-

Whether to persist a logged in session to storage.

+

Whether to persist a logged in session to storage. Defaults to true.

@@ -473,7 +473,7 @@

The Postgres schema which your tables belong to. Must be on the list of - exposed schemas in Supabase. Defaults to 'public'. + exposed schemas in Supabase. Defaults to public.

diff --git a/docs/v1/spec.json b/docs/v1/spec.json index 1a32b935e..eefe0fdac 100644 --- a/docs/v1/spec.json +++ b/docs/v1/spec.json @@ -3118,7 +3118,7 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged in users." + "shortText": "Automatically refreshes the token for logged in users. Defaults to `true`." }, "sources": [ { @@ -3172,7 +3172,7 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks." + "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to `true`." }, "sources": [ { @@ -3297,7 +3297,7 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged in session to storage." + "shortText": "Whether to persist a logged in session to storage. Defaults to `true`." }, "sources": [ { @@ -3345,7 +3345,7 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." + "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." }, "sources": [ { diff --git a/src/lib/types.ts b/src/lib/types.ts index aaeea7594..1d1606dce 100644 --- a/src/lib/types.ts +++ b/src/lib/types.ts @@ -9,7 +9,7 @@ export type Fetch = typeof fetch export type SupabaseClientOptions = { /** - * The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'. + * The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`. */ db?: { schema?: SchemaName @@ -17,11 +17,11 @@ export type SupabaseClientOptions = { auth?: { /** - * Automatically refreshes the token for logged in users. + * Automatically refreshes the token for logged in users. Defaults to true. */ autoRefreshToken?: boolean /** - * Optional key name used for storing tokens in local storage + * Optional key name used for storing tokens in local storage. */ storageKey?: string /** @@ -29,11 +29,11 @@ export type SupabaseClientOptions = { */ persistSession?: boolean /** - * Detect a session from the URL. Used for OAuth login callbacks. + * Detect a session from the URL. Used for OAuth login callbacks. Defaults to true. */ detectSessionInUrl?: boolean /** - * A storage provider. Used to store the logged in session. + * A storage provider. Used to store the logged in session. Defaults to true. */ storage?: SupabaseAuthClientOptions['storage'] }