Interface SupabaseAuthClientOptions

Hierarchy

  • AuthClientOptions
    • SupabaseAuthClientOptions

Properties

autoRefreshToken? debug? detectSessionInUrl? fetch? flowType? hasCustomAuthorizationHeader? headers? lock? persistSession? storage? storageKey? url? userStorage?

Properties

Optional autoRefreshToken

autoRefreshToken?: boolean

Optional debug

debug?: boolean | ((message: string, ...args: any[]) => void)

Optional detectSessionInUrl

detectSessionInUrl?: boolean

Optional fetch

fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

Optional flowType

flowType?: AuthFlowType

Optional Experimental hasCustomAuthorizationHeader

hasCustomAuthorizationHeader?: boolean

Set to "true" if there is a custom authorization header set globally.

Optional headers

headers?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Optional Experimental lock

lock?: LockFunc

Provide your own locking mechanism based on the environment. By default no locking is done at this time.

Optional persistSession

persistSession?: boolean

Optional storage

storage?: SupportedStorage

Optional storageKey

storageKey?: string

Optional url

url?: string

Optional Experimental userStorage

userStorage?: SupportedStorage

Stores the user object in a separate storage location from the rest of the session data. When non-null, storage will only store a JSON object containing the access and refresh token and some adjacent metadata, while userStorage will only contain the user object under the key storageKey + '-user'.

When this option is set and cookie storage is used, getSession() and other functions that load a session from the cookie store might not return back a user. It's very important to always use getUser() to fetch a user object in those scenarios.

Settings

Member Visibility

Theme

Generated using TypeDoc