docs: Add default values to client initialization (#667)

Author: dng

docs/v1/modules/lib_types.html

@@ -325,7 +325,7 @@ <h5>
                     </h5>
                     <div class="tsd-comment tsd-typography">
                       <div class="lead">
-                        <p>Automatically refreshes the token for logged in users.</p>
+                        <p>Automatically refreshes the token for logged in users. Defaults to <code>true</code>.</p>
                       </div>
                     </div>
                   </li>
@@ -359,7 +359,7 @@ <h5>
                     </h5>
                     <div class="tsd-comment tsd-typography">
                       <div class="lead">
-                        <p>Detect a session from the URL. Used for OAuth login callbacks.</p>
+                        <p>Detect a session from the URL. Used for OAuth login callbacks. Defaults to <code>true</code>.</p>
                       </div>
                     </div>
                   </li>
@@ -440,7 +440,7 @@ <h5>
                     </h5>
                     <div class="tsd-comment tsd-typography">
                       <div class="lead">
-                        <p>Whether to persist a logged in session to storage.</p>
+                        <p>Whether to persist a logged in session to storage. Defaults to <code>true</code>.</p>
                       </div>
                     </div>
                   </li>
@@ -473,7 +473,7 @@ <h5>
                       <div class="lead">
                         <p>
                           The Postgres schema which your tables belong to. Must be on the list of
-                          exposed schemas in Supabase. Defaults to &#39;public&#39;.
+                          exposed schemas in Supabase. Defaults to <code>public</code>.
                         </p>
                       </div>
                     </div>

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": [
                     {

src/lib/types.ts

@@ -9,31 +9,31 @@ export type Fetch = typeof fetch
 
 export type SupabaseClientOptions<SchemaName> = {
   /**
-   * 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
   }
 
   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
     /**
      * Whether to persist a logged in session to storage.
      */
     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']
   }