Module lib/types

Type declaration

• Optional auth?: { autoRefreshToken?: boolean; debug?: SupabaseAuthClientOptions["debug"]; detectSessionInUrl?: boolean; flowType?: SupabaseAuthClientOptions["flowType"]; lock?: SupabaseAuthClientOptions["lock"]; persistSession?: boolean; storage?: SupabaseAuthClientOptions["storage"]; storageKey?: string }

  • Optional autoRefreshToken?: boolean

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

  • Optional debug?: SupabaseAuthClientOptions["debug"]

    If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library.

  • Optional detectSessionInUrl?: boolean

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

  • Optional flowType?: SupabaseAuthClientOptions["flowType"]

    OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications.

  • Optional lock?: SupabaseAuthClientOptions["lock"]

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

    experimental

  • Optional persistSession?: boolean

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

  • Optional storage?: SupabaseAuthClientOptions["storage"]

    A storage provider. Used to store the logged-in session.

  • Optional storageKey?: string

    Optional key name used for storing tokens in local storage.

• Optional db?: { schema?: SchemaName }

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

  • Optional schema?: SchemaName

• Optional global?: { fetch?: Fetch; headers?: Record<string, string> }

  • Optional fetch?: Fetch

    A custom fetch implementation.

  • Optional headers?: Record<string, string>

    Optional headers for initializing the client.

• Optional realtime?: RealtimeClientOptions

  Options passed to the realtime-js instance