Skip to content

docs: add default values to client initialization #667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 25, 2022
Merged

docs: add default values to client initialization #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/v1/modules/lib_types.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/v1/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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": [
{
Expand Down
10 changes: 5 additions & 5 deletions src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']
}
Expand Down