- Next.js and Supabase Starter Kit
- - -- The fastest way to build apps with Next.js and Supabase -
- -- Features · - Demo · - Deploy to Vercel · - Clone and run locally · - Feedback and issues - More Examples -
-- -## Features - -- Works across the entire [Next.js](https://nextjs.org) stack - - App Router - - Pages Router - - Middleware - - Client - - Server - - It just works! -- supabase-ssr. A package to configure Supabase Auth to use cookies -- Password-based authentication block installed via the [Supabase UI Library](https://supabase.com/ui/docs/nextjs/password-based-auth) -- Styling with [Tailwind CSS](https://tailwindcss.com) -- Components with [shadcn/ui](https://ui.shadcn.com/) -- Optional deployment with [Supabase Vercel Integration and Vercel deploy](#deploy-your-own) - - Environment variables automatically assigned to Vercel project - -## Demo - -You can view a fully working demo at [demo-nextjs-with-supabase.vercel.app](https://demo-nextjs-with-supabase.vercel.app/). - -## Deploy to Vercel - -Vercel deployment will guide you through creating a Supabase account and project. - -After installation of the Supabase integration, all relevant environment variables will be assigned to the project so the deployment is fully functioning. - -[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This+starter+configures+Supabase+Auth+to+use+cookies%2C+making+the+user%27s+session+available+throughout+the+entire+Next.js+app+-+Client+Components%2C+Server+Components%2C+Route+Handlers%2C+Server+Actions+and+Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png) - -The above will also clone the Starter kit to your GitHub, you can clone that locally and develop locally. - -If you wish to just develop locally and not deploy to Vercel, [follow the steps below](#clone-and-run-locally). - -## Clone and run locally - -1. You'll first need a Supabase project which can be made [via the Supabase dashboard](https://database.new) - -2. Create a Next.js app using the Supabase Starter template npx command - - ```bash - npx create-next-app --example with-supabase with-supabase-app - ``` - - ```bash - yarn create next-app --example with-supabase with-supabase-app - ``` - - ```bash - pnpm create next-app --example with-supabase with-supabase-app - ``` - -3. Use `cd` to change into the app's directory - - ```bash - cd with-supabase-app - ``` - -4. Rename `.env.example` to `.env.local` and update the following: - - ``` - NEXT_PUBLIC_SUPABASE_URL=[INSERT SUPABASE PROJECT URL] - NEXT_PUBLIC_SUPABASE_ANON_KEY=[INSERT SUPABASE PROJECT API ANON KEY] - ``` - - Both `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` can be found in [your Supabase project's API settings](https://supabase.com/dashboard/project/_?showConnect=true) - -5. You can now run the Next.js local development server: - - ```bash - npm run dev - ``` - - The starter kit should now be running on [localhost:3000](http://localhost:3000/). - -6. This template comes with the default shadcn/ui style initialized. If you instead want other ui.shadcn styles, delete `components.json` and [re-install shadcn/ui](https://ui.shadcn.com/docs/installation/next) - -> Check out [the docs for Local Development](https://supabase.com/docs/guides/getting-started/local-development) to also run Supabase locally. - -## Feedback and issues - -Please file feedback and issues over on the [Supabase GitHub org](https://github.com/supabase/supabase/issues/new/choose). - -## More Supabase examples - -- [Next.js Subscription Payments Starter](https://github.com/vercel/nextjs-subscription-payments) -- [Cookie-based Auth and the Next.js 13 App Router (free course)](https://youtube.com/playlist?list=PL5S4mPUpp4OtMhpnp93EFSo42iQ40XjbF) -- [Supabase Auth and the Next.js App Router](https://github.com/supabase/supabase/tree/master/examples/auth/nextjs) diff --git a/test/integration/next/app/layout.tsx b/test/integration/next/app/layout.tsx deleted file mode 100644 index 0cc4b8ea..00000000 --- a/test/integration/next/app/layout.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import type { Metadata } from 'next' - -export const metadata: Metadata = { - title: 'Supabase Integration Test', - description: 'Testing Supabase integration with Next.js', -} - -export default function RootLayout({ children }: { children: React.ReactNode }) { - return ( - - {children} - - ) -} diff --git a/test/integration/next/app/page.tsx b/test/integration/next/app/page.tsx deleted file mode 100644 index e5a23113..00000000 --- a/test/integration/next/app/page.tsx +++ /dev/null @@ -1,20 +0,0 @@ -'use client' - -import { useEffect, useState } from 'react' -import { createClient } from '@/lib/supabase/client' - -export default function Home() { - const supabase = createClient() - const [realtimeStatus, setRealtimeStatus] = useState
{realtimeStatus}
-}
diff --git a/test/integration/next/components.json b/test/integration/next/components.json
deleted file mode 100644
index 4ee62ee1..00000000
--- a/test/integration/next/components.json
+++ /dev/null
@@ -1,21 +0,0 @@
-{
- "$schema": "https://ui.shadcn.com/schema.json",
- "style": "new-york",
- "rsc": true,
- "tsx": true,
- "tailwind": {
- "config": "",
- "css": "app/globals.css",
- "baseColor": "neutral",
- "cssVariables": true,
- "prefix": ""
- },
- "aliases": {
- "components": "@/components",
- "utils": "@/lib/utils",
- "ui": "@/components/ui",
- "lib": "@/lib",
- "hooks": "@/hooks"
- },
- "iconLibrary": "lucide"
-}
diff --git a/test/integration/next/eslint.config.mjs b/test/integration/next/eslint.config.mjs
deleted file mode 100644
index 46f02aef..00000000
--- a/test/integration/next/eslint.config.mjs
+++ /dev/null
@@ -1,14 +0,0 @@
-import { dirname } from 'path'
-import { fileURLToPath } from 'url'
-import { FlatCompat } from '@eslint/eslintrc'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = dirname(__filename)
-
-const compat = new FlatCompat({
- baseDirectory: __dirname,
-})
-
-const eslintConfig = [...compat.extends('next/core-web-vitals', 'next/typescript')]
-
-export default eslintConfig
diff --git a/test/integration/next/lib/supabase/client.ts b/test/integration/next/lib/supabase/client.ts
deleted file mode 100644
index c3c0fd2a..00000000
--- a/test/integration/next/lib/supabase/client.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { createBrowserClient } from '@supabase/ssr'
-
-export function createClient() {
- return createBrowserClient(
- process.env.NEXT_PUBLIC_SUPABASE_URL || 'http://127.0.0.1:54321',
- process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY ||
- 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0'
- )
-}
diff --git a/test/integration/next/lib/supabase/middleware.ts b/test/integration/next/lib/supabase/middleware.ts
deleted file mode 100644
index bed39d2a..00000000
--- a/test/integration/next/lib/supabase/middleware.ts
+++ /dev/null
@@ -1,72 +0,0 @@
-import { createServerClient } from '@supabase/ssr'
-import { NextResponse, type NextRequest } from 'next/server'
-import { hasEnvVars } from '../utils'
-
-export async function updateSession(request: NextRequest) {
- let supabaseResponse = NextResponse.next({
- request,
- })
-
- // If the env vars are not set, skip middleware check. You can remove this once you setup the project.
- if (!hasEnvVars) {
- return supabaseResponse
- }
-
- const supabase = createServerClient(
- process.env.NEXT_PUBLIC_SUPABASE_URL!,
- process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
- {
- cookies: {
- getAll() {
- return request.cookies.getAll()
- },
- setAll(cookiesToSet) {
- cookiesToSet.forEach(({ name, value }) => request.cookies.set(name, value))
- supabaseResponse = NextResponse.next({
- request,
- })
- cookiesToSet.forEach(({ name, value, options }) =>
- supabaseResponse.cookies.set(name, value, options)
- )
- },
- },
- }
- )
-
- // Do not run code between createServerClient and
- // supabase.auth.getUser(). A simple mistake could make it very hard to debug
- // issues with users being randomly logged out.
-
- // IMPORTANT: DO NOT REMOVE auth.getUser()
-
- const {
- data: { user },
- } = await supabase.auth.getUser()
-
- if (
- request.nextUrl.pathname !== '/' &&
- !user &&
- !request.nextUrl.pathname.startsWith('/login') &&
- !request.nextUrl.pathname.startsWith('/auth')
- ) {
- // no user, potentially respond by redirecting the user to the login page
- const url = request.nextUrl.clone()
- url.pathname = '/auth/login'
- return NextResponse.redirect(url)
- }
-
- // IMPORTANT: You *must* return the supabaseResponse object as it is.
- // If you're creating a new response object with NextResponse.next() make sure to:
- // 1. Pass the request in it, like so:
- // const myNewResponse = NextResponse.next({ request })
- // 2. Copy over the cookies, like so:
- // myNewResponse.cookies.setAll(supabaseResponse.cookies.getAll())
- // 3. Change the myNewResponse object to fit your needs, but avoid changing
- // the cookies!
- // 4. Finally:
- // return myNewResponse
- // If this is not done, you may be causing the browser and server to go out
- // of sync and terminate the user's session prematurely!
-
- return supabaseResponse
-}
diff --git a/test/integration/next/lib/supabase/server.ts b/test/integration/next/lib/supabase/server.ts
deleted file mode 100644
index 40633b0c..00000000
--- a/test/integration/next/lib/supabase/server.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-import { createServerClient } from '@supabase/ssr'
-import { cookies } from 'next/headers'
-
-export async function createClient() {
- const cookieStore = await cookies()
-
- return createServerClient(
- process.env.NEXT_PUBLIC_SUPABASE_URL!,
- process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
- {
- cookies: {
- getAll() {
- return cookieStore.getAll()
- },
- setAll(cookiesToSet) {
- try {
- cookiesToSet.forEach(({ name, value, options }) =>
- cookieStore.set(name, value, options)
- )
- } catch {
- // The `setAll` method was called from a Server Component.
- // This can be ignored if you have middleware refreshing
- // user sessions.
- }
- },
- },
- }
- )
-}
diff --git a/test/integration/next/lib/utils.ts b/test/integration/next/lib/utils.ts
deleted file mode 100644
index 8e97e998..00000000
--- a/test/integration/next/lib/utils.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import { clsx, type ClassValue } from 'clsx'
-import { twMerge } from 'tailwind-merge'
-
-export function cn(...inputs: ClassValue[]) {
- return twMerge(clsx(inputs))
-}
-
-// This check can be removed, it is just for tutorial purposes
-export const hasEnvVars =
- process.env.NEXT_PUBLIC_SUPABASE_URL && process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY
diff --git a/test/integration/next/middleware.ts b/test/integration/next/middleware.ts
deleted file mode 100644
index de79b4c5..00000000
--- a/test/integration/next/middleware.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-import { updateSession } from '@/lib/supabase/middleware'
-import { type NextRequest } from 'next/server'
-
-export async function middleware(request: NextRequest) {
- return await updateSession(request)
-}
-
-export const config = {
- matcher: [
- /*
- * Match all request paths except:
- * - _next/static (static files)
- * - _next/image (image optimization files)
- * - favicon.ico (favicon file)
- * - images - .svg, .png, .jpg, .jpeg, .gif, .webp
- * Feel free to modify this pattern to include more paths.
- */
- '/((?!_next/static|_next/image|favicon.ico|.*\\.(?:svg|png|jpg|jpeg|gif|webp)$).*)',
- ],
-}
diff --git a/test/integration/next/next.config.ts b/test/integration/next/next.config.ts
deleted file mode 100644
index 73290639..00000000
--- a/test/integration/next/next.config.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-import type { NextConfig } from 'next'
-
-const nextConfig: NextConfig = {
- /* config options here */
-}
-
-export default nextConfig
diff --git a/test/integration/next/package.json b/test/integration/next/package.json
deleted file mode 100644
index 374cbda1..00000000
--- a/test/integration/next/package.json
+++ /dev/null
@@ -1,44 +0,0 @@
-{
- "private": true,
- "scripts": {
- "dev": "next dev --turbopack",
- "build": "next build",
- "start": "next start",
- "lint": "next lint",
- "test": "playwright test",
- "test:ui": "playwright test --ui",
- "test:debug": "playwright test --debug",
- "test:types": "npx tsd --files tests/types/*.test-d.ts"
- },
- "dependencies": {
- "@radix-ui/react-checkbox": "^1.3.1",
- "@radix-ui/react-dropdown-menu": "^2.1.14",
- "@radix-ui/react-label": "^2.1.6",
- "@radix-ui/react-slot": "^1.2.2",
- "@supabase/ssr": "latest",
- "@supabase/supabase-js": "file:supabase-supabase-js-0.0.0-automated.tgz",
- "class-variance-authority": "^0.7.1",
- "clsx": "^2.1.1",
- "lucide-react": "^0.511.0",
- "next": "latest",
- "next-themes": "^0.4.6",
- "react": "^19.0.0",
- "react-dom": "^19.0.0",
- "tailwind-merge": "^3.3.0"
- },
- "devDependencies": {
- "@eslint/eslintrc": "^3",
- "@playwright/test": "^1.53.0",
- "@types/node": "^20",
- "@types/react": "^19",
- "@types/react-dom": "^19",
- "autoprefixer": "^10.4.20",
- "eslint": "^9",
- "eslint-config-next": "15.3.1",
- "postcss": "^8",
- "tailwindcss": "^3.4.1",
- "tailwindcss-animate": "^1.0.7",
- "tsd": "^0.33.0",
- "typescript": "^5"
- }
-}
diff --git a/test/integration/next/playwright.config.ts b/test/integration/next/playwright.config.ts
deleted file mode 100644
index 001172cf..00000000
--- a/test/integration/next/playwright.config.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { defineConfig, devices } from '@playwright/test'
-
-export default defineConfig({
- testDir: './tests',
- fullyParallel: true,
- forbidOnly: !!process.env.CI,
- retries: 0,
- workers: process.env.CI ? 1 : undefined,
- timeout: 20000,
- reporter: 'html',
- use: {
- baseURL: 'http://localhost:3000',
- trace: 'retain-on-failure',
- screenshot: 'only-on-failure',
- },
- projects: [
- {
- name: 'chromium',
- use: { ...devices['Desktop Chrome'] },
- },
- {
- name: 'firefox',
- use: { ...devices['Desktop Firefox'] },
- },
- {
- name: 'webkit',
- use: { ...devices['Desktop Safari'] },
- },
- ],
- webServer: {
- command: 'npm run dev',
- url: 'http://localhost:3000',
- reuseExistingServer: !process.env.CI,
- },
-})
diff --git a/test/integration/next/postcss.config.mjs b/test/integration/next/postcss.config.mjs
deleted file mode 100644
index d0c615b3..00000000
--- a/test/integration/next/postcss.config.mjs
+++ /dev/null
@@ -1,9 +0,0 @@
-/** @type {import('postcss-load-config').Config} */
-const config = {
- plugins: {
- tailwindcss: {},
- autoprefixer: {},
- },
-}
-
-export default config
diff --git a/test/integration/next/tailwind.config.ts b/test/integration/next/tailwind.config.ts
deleted file mode 100644
index abd2d09f..00000000
--- a/test/integration/next/tailwind.config.ts
+++ /dev/null
@@ -1,63 +0,0 @@
-import type { Config } from 'tailwindcss'
-
-export default {
- darkMode: ['class'],
- content: [
- './pages/**/*.{js,ts,jsx,tsx,mdx}',
- './components/**/*.{js,ts,jsx,tsx,mdx}',
- './app/**/*.{js,ts,jsx,tsx,mdx}',
- './src/**/*.{js,ts,jsx,tsx,mdx}',
- ],
- theme: {
- extend: {
- colors: {
- background: 'hsl(var(--background))',
- foreground: 'hsl(var(--foreground))',
- card: {
- DEFAULT: 'hsl(var(--card))',
- foreground: 'hsl(var(--card-foreground))',
- },
- popover: {
- DEFAULT: 'hsl(var(--popover))',
- foreground: 'hsl(var(--popover-foreground))',
- },
- primary: {
- DEFAULT: 'hsl(var(--primary))',
- foreground: 'hsl(var(--primary-foreground))',
- },
- secondary: {
- DEFAULT: 'hsl(var(--secondary))',
- foreground: 'hsl(var(--secondary-foreground))',
- },
- muted: {
- DEFAULT: 'hsl(var(--muted))',
- foreground: 'hsl(var(--muted-foreground))',
- },
- accent: {
- DEFAULT: 'hsl(var(--accent))',
- foreground: 'hsl(var(--accent-foreground))',
- },
- destructive: {
- DEFAULT: 'hsl(var(--destructive))',
- foreground: 'hsl(var(--destructive-foreground))',
- },
- border: 'hsl(var(--border))',
- input: 'hsl(var(--input))',
- ring: 'hsl(var(--ring))',
- chart: {
- '1': 'hsl(var(--chart-1))',
- '2': 'hsl(var(--chart-2))',
- '3': 'hsl(var(--chart-3))',
- '4': 'hsl(var(--chart-4))',
- '5': 'hsl(var(--chart-5))',
- },
- },
- borderRadius: {
- lg: 'var(--radius)',
- md: 'calc(var(--radius) - 2px)',
- sm: 'calc(var(--radius) - 4px)',
- },
- },
- },
- plugins: [require('tailwindcss-animate')],
-} satisfies Config
diff --git a/test/integration/next/tests/home.spec.ts b/test/integration/next/tests/home.spec.ts
deleted file mode 100644
index 0703edf7..00000000
--- a/test/integration/next/tests/home.spec.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-import { test, expect } from '@playwright/test'
-
-test.describe('Home Page', () => {
- test('should subscribe to realtime channel', async ({ page }) => {
- await page.goto('/')
- await expect(page.getByTestId('realtime_status')).toHaveText('SUBSCRIBED')
- })
-})
diff --git a/test/integration/next/tests/types/types.test-d.ts b/test/integration/next/tests/types/types.test-d.ts
deleted file mode 100644
index 830d4f59..00000000
--- a/test/integration/next/tests/types/types.test-d.ts
+++ /dev/null
@@ -1,180 +0,0 @@
-import { createServerClient, createBrowserClient } from '@supabase/ssr'
-import { expectType } from 'tsd'
-
-// Copied from ts-expect
-// https://github.com/TypeStrong/ts-expect/blob/master/src/index.ts#L23-L27
-export type TypeEqualClass AuthApiError
Hierarchy
- AuthError
- AuthApiError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
status: number
code: undefined | string
Returns AuthApiError
Properties
Protected __is
code
message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthError
Hierarchy
- Error
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Optional status: number
Optional code: string
Returns AuthError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthImplicitGrantRedirectError
Hierarchy
- CustomAuthError
- AuthImplicitGrantRedirectError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Optional details: null | { code: string; error: string }
Returns AuthImplicitGrantRedirectError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+details
message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Returns { details: null | { code: string; error: string }; message: string; name: string; status: number }
details: null | { code: string; error: string }
message: string
name: string
status: number
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthInvalidCredentialsError
Hierarchy
- CustomAuthError
- AuthInvalidCredentialsError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Returns AuthInvalidCredentialsError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthInvalidJwtError
Hierarchy
- CustomAuthError
- AuthInvalidJwtError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Returns AuthInvalidJwtError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthInvalidTokenResponseError
Hierarchy
- CustomAuthError
- AuthInvalidTokenResponseError
Index
Constructors
Properties
Methods
Constructors
constructor
Returns AuthInvalidTokenResponseError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthPKCEGrantCodeExchangeError
Hierarchy
- CustomAuthError
- AuthPKCEGrantCodeExchangeError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Optional details: null | { code: string; error: string }
Returns AuthPKCEGrantCodeExchangeError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+details
message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Returns { details: null | { code: string; error: string }; message: string; name: string; status: number }
details: null | { code: string; error: string }
message: string
name: string
status: number
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthRetryableFetchError
Hierarchy
- CustomAuthError
- AuthRetryableFetchError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
status: number
Returns AuthRetryableFetchError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthSessionMissingError
Hierarchy
- CustomAuthError
- AuthSessionMissingError
Index
Constructors
Properties
Methods
Constructors
constructor
Returns AuthSessionMissingError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthUnknownError
Hierarchy
- AuthError
- AuthUnknownError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
originalError: unknown
Returns AuthUnknownError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
original
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class AuthWeakPasswordError
+
This error is thrown on certain methods when the password used is deemed +weak. Inspect the reasons to identify what password strength rules are +inadequate.
+Hierarchy
- CustomAuthError
- AuthWeakPasswordError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
status: number
reasons: string[]
Returns AuthWeakPasswordError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
reasons
+
Reasons why the password is deemed weak.
+Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class CustomAuthError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
name: string
status: number
code: undefined | string
Returns CustomAuthError
Properties
Protected __is
code
+
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+message
name
Optional stack
status
+
HTTP status code that caused the error.
+Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class FunctionsError
Hierarchy
- Error
- FunctionsError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Optional name: string
Optional context: any
Returns FunctionsError
Properties
context
message
name
Optional stack
Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class FunctionsFetchError
Hierarchy
- FunctionsError
- FunctionsFetchError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
context: any
Returns FunctionsFetchError
Properties
context
message
name
Optional stack
Static Optional prepare
+
Optional override for formatting stack traces
+Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class FunctionsHttpError
Hierarchy
- FunctionsError
- FunctionsHttpError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
context: any
Returns FunctionsHttpError
Properties
context
message
name
Optional stack
Static Optional prepare
+
Optional override for formatting stack traces
+Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class FunctionsRelayError
Hierarchy
- FunctionsError
- FunctionsRelayError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
context: any
Returns FunctionsRelayError
Properties
context
message
name
Optional stack
Static Optional prepare
+
Optional override for formatting stack traces
+Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class GoTrueAdminApi
Hierarchy
- GoTrueAdminApi
Index
Constructors
constructor
Parameters
__namedParameters: { fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>); headers?: {}; url: string }
Optional fetch?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Optional headers?: {}
[key: string]: string
url: string
Returns GoTrueAdminApi
Properties
Private _delete
Private _list
Protected fetch
Type declaration
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Protected headers
Type declaration
[key: string]: string
mfa
+
Contains all MFA administration methods.
+Protected url
Methods
create
- +
Creates a new user. +This function should only be called on a server. Never expose your
+service_rolekey in the browser.Parameters
attributes: AdminUserAttributes
Returns Promise<UserResponse>
delete
- +
Delete a user. Requires a
+service_rolekey.Parameters
id: string
+The user id you want to remove.
+Optional shouldSoftDelete: boolean
+If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible. +Defaults to false for backward compatibility.
+This function should only be called on a server. Never expose your
+service_rolekey in the browser.
Returns Promise<UserResponse>
generate
- +
Generates email links and OTPs to be sent via a custom email provider.
+Parameters
params: GenerateLinkParams
Returns Promise<GenerateLinkResponse>
get
- +
Get user by id.
+Parameters
uid: string
+The user's unique identifier
+This function should only be called on a server. Never expose your
+service_rolekey in the browser.
Returns Promise<UserResponse>
invite
- +
Sends an invite link to an email address.
+Parameters
email: string
+The email address of the user.
+Optional options: { data?: object; redirectTo?: string }
+Additional options to be included when inviting.
+Optional data?: object
+A custom data object to store additional metadata about the user. This maps to the
+auth.users.user_metadatacolumn.Optional redirect
To?: string +The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.
+
Returns Promise<UserResponse>
list
- +
Get a list of users.
+This function should only be called on a server. Never expose your
+service_rolekey in the browser.Parameters
Optional params: PageParams
+An object which supports
+pageandperPageas numbers, to alter the paginated results.
Returns Promise<{ data: { aud: string; users: AuthUser[] } & Pagination; error: null } | { data: { users: [] }; error: AuthError }>
sign
- +
Removes a logged-in session.
+Parameters
jwt: string
+A valid, logged-in JWT.
+Optional scope: "global" | "local" | "others"
+The logout sope.
+
Returns Promise<{ data: null; error: null | AuthError }>
update
- +
Updates the user data.
+Parameters
uid: string
attributes: AdminUserAttributes
+The data you want to update.
+This function should only be called on a server. Never expose your
+service_rolekey in the browser.
Returns Promise<UserResponse>
Generated using TypeDoc
Class GoTrueClient
Hierarchy
- GoTrueClient
Index
Constructors
Properties
- __load
Session - _acquire
Lock - _auto
Refresh Token Tick - _call
Refresh Token - _challenge
- _challenge
And Verify - _debug
- _emit
Initial Session - _enroll
- _exchange
Code For Session - _get
Authenticator Assurance Level - _get
Session FromURL - _get
Url For Provider - _get
User - _handle
Provider Sign In - _handle
Visibility Change - _initialize
- _is
Implicit Grant Callback - _isPKCECallback
- _is
Valid Session - _list
Factors - _notify
All Subscribers - _on
Visibility Changed - _reauthenticate
- _recover
And Refresh - _refresh
Access Token - _remove
Session - _remove
Visibility Changed Callback - _save
Session - _start
Auto Refresh - _stop
Auto Refresh - _unenroll
- _use
Session - _verify
- admin
- auto
Refresh Ticker - auto
Refresh Token - broadcast
Channel - detect
Session In Url - fetch
- fetch
Jwk - flow
Type - has
Custom Authorization Header - headers
- initialize
Promise - instanceID
- lock
- lock
Acquired - log
Debug Messages - logger
- memory
Storage - mfa
- pending
In Lock - persist
Session - refreshing
Deferred - sign
In With Solana - state
Change Emitters - storage
- storage
Key - suppress
Get Session Warning - url
- user
Storage - visibility
Changed Callback - next
InstanceID
Accessors
Methods
- _refresh
Session - _set
Session - _sign
Out - _update
User - exchange
Code For Session - get
Claims - get
Session - get
User - get
User Identities - initialize
- link
Identity - on
Auth State Change - reauthenticate
- refresh
Session - resend
- reset
Password For Email - set
Session - sign
In Anonymously - sign
In With Id Token - sign
In WithOAuth - sign
In With Otp - sign
In With Password - sign
In WithSSO - sign
In With Web3 - sign
Out - sign
Up - start
Auto Refresh - stop
Auto Refresh - unlink
Identity - update
User - verify
Otp
Constructors
constructor
- +
Create a new client for use in the browser.
+Parameters
options: GoTrueClientOptions
Returns GoTrueClient
Properties
Private __load
+
NEVER USE DIRECTLY!
+Always use {@link #_useSession}.
+Private _acquire
+
Acquires a global lock based on the storage key.
+Private _auto
+
Runs the auto refresh token tick.
+Private _call
Private _challenge
+
{@see GoTrueMFAApi#challenge}
+Private _challenge
+
{@see GoTrueMFAApi#challengeAndVerify}
+Private _debug
Private _emit
Private _enroll
+
{@see GoTrueMFAApi#enroll}
+Private _exchange
Private _get
+
{@see GoTrueMFAApi#getAuthenticatorAssuranceLevel}
+Private _get
+
Gets the session data from a URL string
+Private _get
+
Generates the relevant login URL for a third-party provider.
+Private _get
Private _handle
Private _handle
+
Registers callbacks on the browser / platform, which in-turn run +algorithms when the browser window/tab are in foreground. On non-browser +platforms it assumes always foreground.
+Private _initialize
+
IMPORTANT:
+-
+
- Never throw in this method, as it is called from the constructor +
- Never return a session from this method as it would be cached over +the whole lifetime of the client +
Private _is
+
Checks if the current URL contains parameters given by an implicit oauth grant flow (https://www.rfc-editor.org/rfc/rfc6749.html#section-4.2)
+Private _isPKCECallback
+
Checks if the current URL and backing storage contain parameters given by a PKCE flow
+Private _is
Private _list
+
{@see GoTrueMFAApi#listFactors}
+Private _notify
Private _on
+
Callback registered with window.addEventListener('visibilitychange').
Private _reauthenticate
Private _recover
+
Recovers the session from LocalStorage and refreshes the token +Note: this method is async to accommodate for AsyncStorage e.g. in React native.
+Private _refresh
+
Generates a new JWT.
+Private _remove
Private _remove
+
Removes any registered visibilitychange callback.
+{@see #startAutoRefresh} +{@see #stopAutoRefresh}
+Private _save
+
set currentSession and currentUser +process to _startAutoRefreshToken if possible
+Private _start
+
This is the private implementation of {@link #startAutoRefresh}. Use this +within the library.
+Private _stop
+
This is the private implementation of {@link #stopAutoRefresh}. Use this +within the library.
+Private _unenroll
Private _use
+
Use instead of {@link #getSession} inside the library. It is +semantically usually what you want, as getting a session involves some +processing afterwards that requires only one client operating on the +session at once across multiple tabs or processes.
+Private _verify
+
{@see GoTrueMFAApi#verify}
+admin
+
Namespace for the GoTrue admin methods. +These methods should only be used in a trusted server-side environment.
+Protected auto
Protected auto
Protected broadcast
+
Used to broadcast state change events to other tabs listening.
+Protected detect
Protected fetch
Type declaration
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Private fetch
Protected flow
Protected has
Protected headers
Type declaration
[key: string]: string
Protected initialize
+
Keeps track of the async client initialization.
+When null or not yet resolved the auth state is unknown
+Once resolved the the auth state is known and it's save to call any further client methods.
+Keep extra care to never reject or throw uncaught errors
Private instanceID
Protected lock
Protected lock
Protected log
Protected logger
Type declaration
Parameters
message: string
Rest ...args: any[]
Returns void
Protected memory
mfa
+
Namespace for the MFA methods.
+Protected pending
Protected persist
Protected refreshing
Private sign
Protected state
Protected storage
Protected storage
+
The storage key used to identify the values saved in localStorage
+Protected suppress
Protected url
Protected user
Protected visibility
Static Private next
Accessors
Protected jwks
Protected jwks_
Returns number
Parameters
value: number
Returns void
Methods
Protected _refresh
Parameters
Optional currentSession: { refresh_token: string }
refresh_
token: string
Returns Promise<AuthResponse>
Protected _set
Parameters
currentSession: { access_token: string; refresh_token: string }
access_
token: string refresh_
token: string
Returns Promise<AuthResponse>
Protected _sign
Protected _update
Parameters
attributes: UserAttributes
Optional options: { emailRedirectTo?: string }
Optional email
Redirect To?: string
Returns Promise<UserResponse>
exchange
- +
Log in an existing user by exchanging an Auth Code issued during the PKCE flow.
+Parameters
authCode: string
Returns Promise<AuthTokenResponse>
get
- +
Extracts the JWT claims present in the access token by first verifying the +JWT against the server's JSON Web Key Set endpoint +
+/.well-known/jwks.jsonwhich is often cached, resulting in significantly +faster responses. Prefer this method over {@link #getUser} which always +sends a request to the Auth server for each JWT.If the project is not using an asymmetric JWT signing key (like ECC or +RSA) it always sends a request to the Auth server (similar to {@link +#getUser}) to verify the JWT.
+Parameters
Optional jwt: string
+An optional specific JWT you wish to verify, not the one you + can obtain from {@link #getSession}.
+Optional options: { allowExpired?: boolean; jwks?: { keys: JWK[] }; keys?: JWK[] }
+Various additional options that allow you to customize the + behavior of this method.
+
Returns Promise<{ data: { claims: JwtPayload; header: JwtHeader; signature: Uint8Array }; error: null } | { data: null; error: AuthError } | { data: null; error: null }>
get
- +
Returns the session, refreshing it if necessary.
+The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.
+IMPORTANT: This method loads values directly from the storage attached +to the client. If that storage is based on request cookies for example, +the values in it may not be authentic and therefore it's strongly advised +against using this method and its results in such circumstances. A warning +will be emitted if this is detected. Use {@link #getUser()} instead.
+Returns Promise<{ data: { session: AuthSession }; error: null } | { data: { session: null }; error: AuthError } | { data: { session: null }; error: null }>
get
- +
Gets the current user details if there is an existing session. This method +performs a network request to the Supabase Auth server, so the returned +value is authentic and can be used to base authorization rules on.
+Parameters
Optional jwt: string
+Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.
+
Returns Promise<UserResponse>
get
- +
Gets all the identities linked to a user.
+Returns Promise<{ data: { identities: UserIdentity[] }; error: null } | { data: null; error: AuthError }>
initialize
- +
Initializes the client session either from the url or from storage. +This method is automatically called when instantiating the client, but should also be called +manually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc).
+Returns Promise<InitializeResult>
link
- +
Links an oauth identity to an existing user. +This method supports the PKCE flow.
+Parameters
credentials: SignInWithOAuthCredentials
Returns Promise<OAuthResponse>
on
- +
Receive a notification every time an auth event happens.
+Parameters
callback: ((event: AuthChangeEvent, session: null | AuthSession) => void | Promise<void>)
+A callback function to be invoked when an auth event happens.
+Parameters
event: AuthChangeEvent
session: null | AuthSession
Returns void | Promise<void>
Returns { data: { subscription: Subscription } }
data: { subscription: Subscription }
subscription: Subscription
reauthenticate
- +
Sends a reauthentication OTP to the user's email or phone number. +Requires the user to be signed-in.
+Returns Promise<AuthResponse>
refresh
- +
Returns a new session, regardless of expiry status. +Takes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession(). +If the current session's refresh token is invalid, an error will be thrown.
+Parameters
Optional currentSession: { refresh_token: string }
+The current session. If passed in, it must contain a refresh token.
+refresh_
token: string
Returns Promise<AuthResponse>
resend
- +
Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.
+Parameters
credentials: ResendParams
Returns Promise<AuthOtpResponse>
reset
- +
Sends a password reset request to an email address. This method supports the PKCE flow.
+Parameters
email: string
+The email address of the user.
+Optional options: { captchaToken?: string; redirectTo?: string }
Optional captcha
Token?: string +Verification token received when the user completes the captcha on the site.
+Optional redirect
To?: string +The URL to send the user to after they click the password reset link.
+
Returns Promise<{ data: {}; error: null } | { data: null; error: AuthError }>
set
- +
Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session. +If the refresh token or access token in the current session is invalid, an error will be thrown.
+Parameters
currentSession: { access_token: string; refresh_token: string }
+The current session that minimally contains an access token and refresh token.
+access_
token: string refresh_
token: string
Returns Promise<AuthResponse>
sign
- +
Creates a new anonymous user.
+Parameters
Optional credentials: SignInAnonymouslyCredentials
Returns Promise<AuthResponse>
A session where the is_anonymous claim in the access token JWT set to true
+
sign
- +
Allows signing in with an OIDC ID token. The authentication provider used +should be enabled and configured.
+Parameters
credentials: SignInWithIdTokenCredentials
Returns Promise<AuthTokenResponse>
sign
- +
Log in an existing user via a third-party provider. +This method supports the PKCE flow.
+Parameters
credentials: SignInWithOAuthCredentials
Returns Promise<OAuthResponse>
sign
- +
Log in a user using magiclink or a one-time password (OTP).
+If the
+{{ .ConfirmationURL }}variable is specified in the email template, a magiclink will be sent. +If the{{ .Token }}variable is specified in the email template, an OTP will be sent. +If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.Be aware that you may get back an error message that will not distinguish +between the cases where the account does not exist or, that the account +can only be accessed via social login.
+Do note that you will need to configure a Whatsapp sender on Twilio +if you are using phone sign in with the 'whatsapp' channel. The whatsapp +channel is not supported on other providers +at this time. +This method supports PKCE when an email is passed.
+Parameters
credentials: SignInWithPasswordlessCredentials
Returns Promise<AuthOtpResponse>
sign
- +
Log in an existing user with an email and password or phone and password.
+Be aware that you may get back an error message that will not distinguish +between the cases where the account does not exist or that the +email/phone and password combination is wrong or that the account can only +be accessed via social login.
+Parameters
credentials: SignInWithPasswordCredentials
Returns Promise<AuthTokenResponsePassword>
sign
- +
Attempts a single-sign on using an enterprise Identity Provider. A +successful SSO attempt will redirect the current page to the identity +provider authorization page. The redirect URL is implementation and SSO +protocol specific.
+You can use it by providing a SSO domain. Typically you can extract this +domain by asking users for their email address. If this domain is +registered on the Auth instance the redirect will use that organization's +currently active SSO Identity Provider for the login.
+If you have built an organization-specific login page, you can use the +organization's SSO Identity Provider UUID directly instead.
+Parameters
params: SignInWithSSO
Returns Promise<SSOResponse>
sign
- +
Signs in a user by verifying a message signed by the user's private key. +Only Solana supported at this time, using the Sign in with Solana standard.
+Parameters
credentials: SolanaWeb3Credentials
Returns Promise<{ data: { session: AuthSession; user: AuthUser }; error: null } | { data: { session: null; user: null }; error: AuthError }>
sign
- +
Inside a browser context,
+signOut()will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a"SIGNED_OUT"event.For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to
+auth.api.signOut(JWT: string). +There is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.If using
+othersscope, noSIGNED_OUTevent is fired!Parameters
Optional options: SignOut
Returns Promise<{ error: null | AuthError }>
sign
- +
Creates a new user.
+Be aware that if a user account exists in the system you may get back an +error message that attempts to hide this information from the user. +This method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.
+Parameters
credentials: SignUpWithPasswordCredentials
Returns Promise<AuthResponse>
A logged-in session if the server has "autoconfirm" ON
+
start
- +
Starts an auto-refresh process in the background. The session is checked +every few seconds. Close to the time of expiration a process is started to +refresh the session. If refreshing fails it will be retried for as long as +necessary.
+If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need +to call this function, it will be called for you.
+On browsers the refresh process works only when the tab/window is in the +foreground to conserve resources as well as prevent race conditions and +flooding auth with requests. If you call this method any managed +visibility change callback will be removed and you must manage visibility +changes on your own.
+On non-browser platforms the refresh process works continuously in the +background, which may not be desirable. You should hook into your +platform's foreground indication mechanism and call these methods +appropriately to conserve resources.
+{@see #stopAutoRefresh}
+Returns Promise<void>
stop
- +
Stops an active auto refresh process running in the background (if any).
+If you call this method any managed visibility change callback will be +removed and you must manage visibility changes on your own.
+See {@link #startAutoRefresh} for more details.
+Returns Promise<void>
unlink
- +
Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.
+Parameters
identity: UserIdentity
Returns Promise<{ data: {}; error: null } | { data: null; error: AuthError }>
update
- +
Updates user data for a logged in user.
+Parameters
attributes: UserAttributes
Optional options: { emailRedirectTo?: string }
Optional email
Redirect To?: string
Returns Promise<UserResponse>
verify
- +
Log in a user given a User supplied OTP or TokenHash received through mobile or email.
+Parameters
params: VerifyOtpParams
Returns Promise<AuthResponse>
Generated using TypeDoc
Class NavigatorLockAcquireTimeoutError
Hierarchy
- LockAcquireTimeoutError
- NavigatorLockAcquireTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Returns NavigatorLockAcquireTimeoutError
Properties
Readonly is
message
name
Optional stack
Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class PostgrestError
Hierarchy
- Error
- PostgrestError
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
context: { code: string; details: string; hint: string; message: string }
code: string
details: string
hint: string
message: string
Returns PostgrestError
Properties
code
details
hint
message
name
Optional stack
Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- +
Create .stack property on a target object
+Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Generated using TypeDoc
Class RealtimeChannel
+
A channel is the basic building block of Realtime +and narrows the scope of data flow to subscribed clients. +You can think of a channel as a chatroom where participants are able to see who's online +and send and receive messages.
+Hierarchy
- RealtimeChannel
Index
Constructors
constructor
Parameters
topic: string
params: undefined | RealtimeChannelOptions
socket: RealtimeClient
Returns RealtimeChannel
Properties
bindings
Type declaration
[key: string]: { callback: Function; filter: {}; id?: string; type: string }[]
broadcast
join
joined
params
presence
private
push
rejoin
socket
state
sub
timeout
topic
+
Topic name can be any string.
+Methods
on
- +
Creates an event handler that listens to changes.
+Parameters
type: "presence"
filter: { event: "sync" }
event: "sync"
callback: (() => void)
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "presence"
filter: { event: "join" }
event: "join"
callback: ((payload: RealtimePresenceJoinPayload<T>) => void)
Parameters
payload: RealtimePresenceJoinPayload<T>
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "presence"
filter: { event: "leave" }
event: "leave"
callback: ((payload: RealtimePresenceLeavePayload<T>) => void)
Parameters
payload: RealtimePresenceLeavePayload<T>
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "postgres_changes"
filter: RealtimePostgresChangesFilter<"*">
callback: ((payload: RealtimePostgresChangesPayload<T>) => void)
Parameters
payload: RealtimePostgresChangesPayload<T>
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "postgres_changes"
filter: RealtimePostgresChangesFilter<"INSERT">
callback: ((payload: RealtimePostgresInsertPayload<T>) => void)
Parameters
payload: RealtimePostgresInsertPayload<T>
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "postgres_changes"
filter: RealtimePostgresChangesFilter<"UPDATE">
callback: ((payload: RealtimePostgresUpdatePayload<T>) => void)
Parameters
payload: RealtimePostgresUpdatePayload<T>
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "postgres_changes"
filter: RealtimePostgresChangesFilter<"DELETE">
callback: ((payload: RealtimePostgresDeletePayload<T>) => void)
Parameters
payload: RealtimePostgresDeletePayload<T>
Returns void
Returns RealtimeChannel
- +
The following is placed here to display on supabase.com/docs/reference/javascript/subscribe.
+Parameters
type: "broadcast"
+One of "broadcast", "presence", or "postgres_changes".
+filter: { event: string }
+Custom object specific to the Realtime feature detailing which payloads to receive.
+event: string
callback: ((payload: { event: string; type: "broadcast" }) => void)
+Function to be invoked when event handler is triggered.
+Parameters
payload: { event: string; type: "broadcast" }
[key: string]: any
event: string
type: "broadcast"
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "broadcast"
filter: { event: string }
event: string
callback: ((payload: { event: string; payload: T; type: "broadcast" }) => void)
Parameters
payload: { event: string; payload: T; type: "broadcast" }
event: string
payload: T
type: "broadcast"
Returns void
Returns RealtimeChannel
Type Parameters
T extends {}
Parameters
type: "system"
filter: {}
callback: ((payload: any) => void)
Parameters
payload: any
Returns void
Returns RealtimeChannel
presence
Type Parameters
T extends {} = {}
Returns RealtimePresenceState<T>
send
- +
Sends a message into the channel.
+Parameters
args: { event: string; payload?: any; type: "presence" | "postgres_changes" | "broadcast" }
+Arguments to send to channel
+[key: string]: any
event: string
+The name of the event being sent
+Optional payload?: any
+Payload to be sent
+type: "presence" | "postgres_changes" | "broadcast"
+The type of event to send
+
Optional opts: {}
+Options to be used during the send process
+[key: string]: any
Returns Promise<RealtimeChannelSendResponse>
subscribe
- +
Subscribe registers your client with the server
+Parameters
Optional callback: ((status: REALTIME_SUBSCRIBE_STATES, err?: Error) => void)
Parameters
status: REALTIME_SUBSCRIBE_STATES
Optional err: Error
Returns void
Optional timeout: number
Returns RealtimeChannel
teardown
- +
Teardown the channel.
+Destroys and stops related timers.
+Returns void
track
Parameters
payload: {}
[key: string]: any
Optional opts: {}
[key: string]: any
Returns Promise<RealtimeChannelSendResponse>
unsubscribe
- +
Leaves the channel.
+Unsubscribes from server events, and instructs channel to terminate on server. +Triggers onClose() hooks.
+To receive leave acknowledgements, use the a
+receivehook to bind to the server ack, ie: +channel.unsubscribe().receive("ok", () => alert("left!") )Parameters
Optional timeout: number
Returns Promise<"error" | "ok" | "timed out">
untrack
Parameters
Optional opts: {}
[key: string]: any
Returns Promise<RealtimeChannelSendResponse>
update
Parameters
payload: {}
[key: string]: any
Returns void
Generated using TypeDoc
Class RealtimeClient
Hierarchy
- RealtimeClient
Index
Constructors
Properties
- _auth
Promise - _connection
State - _was
Manual Disconnect - _worker
Object Url - access
Token - access
Token Value - api
Key - channels
- conn
- decode
- encode
- end
Point - fetch
- headers
- heartbeat
Callback - heartbeat
Interval Ms - heartbeat
Timer - http
Endpoint - log
Level - logger
- params
- pending
Heartbeat Ref - reconnect
After Ms - reconnect
Timer - ref
- send
Buffer - serializer
- state
Change Callbacks - timeout
- transport
- worker
- worker
Ref - worker
Url
Methods
Constructors
constructor
- +
Initializes the Socket.
+Parameters
endPoint: string
+The string WebSocket endpoint, ie, "ws://example.com/socket", "wss://example.com", "/socket" (inherited host & protocol)
+Optional options: RealtimeClientOptions
Returns RealtimeClient
Properties
Private _auth
Private _connection
Private _was
Private _worker
access
access
api
channels
conn
decode
encode
end
fetch
Type declaration
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Optional headers
Type declaration
[key: string]: string
heartbeat
Type declaration
Parameters
status: HeartbeatStatus
Returns void
heartbeat
heartbeat
http
Optional log
logger
Optional params
Type declaration
[key: string]: string
pending
reconnect
reconnect
ref
send
serializer
state
Type declaration
close: Function[]
error: Function[]
message: Function[]
open: Function[]
timeout
transport
Optional worker
Optional worker
Optional worker
Methods
channel
Parameters
topic: string
Optional params: RealtimeChannelOptions
Returns RealtimeChannel
connect
- +
Connects the socket, unless already connected.
+Returns void
connection
- +
Returns the current state of the socket.
+Returns CONNECTION_STATE
disconnect
- +
Disconnects the socket.
+Parameters
Optional code: number
+A numeric status code to send on disconnect.
+Optional reason: string
+A custom reason for the disconnect.
+
Returns void
endpointURL
- +
Returns the URL of the websocket.
+Returns string
string The URL of the websocket.
+
flush
- +
Flushes send buffer
+Returns void
get
- +
Returns all created channels
+Returns RealtimeChannel[]
is
- +
Returns
+trueis the connection is open.Returns boolean
is
- +
Returns
+trueif the connection is currently connecting.Returns boolean
is
- +
Returns
+trueif the connection is currently disconnecting.Returns boolean
log
- +
Logs the message.
+For customized logging,
+this.loggercan be overridden.Parameters
kind: string
msg: string
Optional data: any
Returns void
on
Parameters
callback: ((status: HeartbeatStatus) => void)
Parameters
status: HeartbeatStatus
Returns void
Returns void
push
- +
Push out a message if the socket is connected.
+If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.
+Parameters
data: RealtimeMessage
Returns void
remove
- +
Unsubscribes and removes all channels
+Returns Promise<RealtimeRemoveChannelResponse[]>
remove
- +
Unsubscribes and removes a single channel
+Parameters
channel: RealtimeChannel
+A RealtimeChannel instance
+
Returns Promise<RealtimeRemoveChannelResponse>
send
- +
Sends a heartbeat message if the socket is connected.
+Returns Promise<void>
set
- +
Sets the JWT access token used for channel subscription authorization and Realtime RLS.
+If param is null it will use the
+accessTokencallback function or the token set on the client.On callback used, it will set the value of the token internal to the client.
+Parameters
Optional token: null | string
+A JWT string to override the token set on the client.
+
Returns Promise<void>
Generated using TypeDoc
Class RealtimePresence
Hierarchy
- RealtimePresence
Index
Constructors
Properties
Constructors
constructor
- +
Initializes the Presence.
+Parameters
channel: RealtimeChannel
+The RealtimeChannel
+Optional opts: PresenceOpts
+The options, + for example
+{events: {state: 'state', diff: 'diff'}}
Returns RealtimePresence
Properties
caller
Type declaration
on
Join: PresenceOnJoinCallback on
Leave: PresenceOnLeaveCallback on
Sync:function Returns void
channel
enabled
join
pending
state
Generated using TypeDoc
Class SupabaseClient<Database, SchemaNameOrClientOptions, SchemaName, Schema, ClientOptions>
+
Supabase Client.
+An isomorphic Javascript client for interacting with Postgres.
+Type Parameters
Database = any
SchemaNameOrClientOptions extends string & keyof Omit<Database, "__InternalSupabase"> | { PostgrestVersion: string } = "public" extends keyof Omit<Database, "__InternalSupabase"> ? "public" : string & keyof Omit<Database, "__InternalSupabase">
SchemaName extends string & keyof Omit<Database, "__InternalSupabase"> = SchemaNameOrClientOptions extends string & keyof Omit<Database, "__InternalSupabase"> ? SchemaNameOrClientOptions : "public" extends keyof Omit<Database, "__InternalSupabase"> ? "public" : string & keyof Omit<Omit<Database, "__InternalSupabase">, "__InternalSupabase">
Schema extends Omit<Database, "__InternalSupabase">[SchemaName] extends GenericSchema ? Omit<Database, "__InternalSupabase">[SchemaName] : never = Omit<Database, "__InternalSupabase">[SchemaName] extends GenericSchema ? Omit<Database, "__InternalSupabase">[SchemaName] : never
ClientOptions extends { PostgrestVersion: string } = SchemaNameOrClientOptions extends string & keyof Omit<Database, "__InternalSupabase"> ? Database extends { __InternalSupabase: { PostgrestVersion: string } } ? Database["__InternalSupabase"] : { PostgrestVersion: "12" } : SchemaNameOrClientOptions extends { PostgrestVersion: string } ? SchemaNameOrClientOptions : never
Hierarchy
- SupabaseClient
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- +
Create a new client for use in the browser.
+Type Parameters
Database = any
SchemaNameOrClientOptions extends string | { PostgrestVersion: string } = "public" extends Exclude<keyof Database, "__InternalSupabase"> ? "public" : string & Exclude<keyof Database, "__InternalSupabase">
SchemaName extends string = SchemaNameOrClientOptions extends string & Exclude<keyof Database, "__InternalSupabase"> ? SchemaNameOrClientOptions : "public" extends Exclude<keyof Database, "__InternalSupabase"> ? "public" : string & Exclude<Exclude<keyof Database, "__InternalSupabase">, "__InternalSupabase">
Schema extends GenericSchema = Omit<Database, "__InternalSupabase">[SchemaName] extends GenericSchema ? any[any] : never
ClientOptions extends { PostgrestVersion: string } = SchemaNameOrClientOptions extends string & Exclude<keyof Database, "__InternalSupabase"> ? Database extends { __InternalSupabase: { PostgrestVersion: string } } ? Database["__InternalSupabase"] : { PostgrestVersion: "12" } : SchemaNameOrClientOptions extends { PostgrestVersion: string } ? SchemaNameOrClientOptions : never
Parameters
supabaseUrl: string
+The unique Supabase URL which is supplied when you create a new project in your project dashboard.
+supabaseKey: string
+The unique Supabase Key which is supplied when you create a new project in your project dashboard.
+Optional options: SupabaseClientOptions<SchemaName>
Returns SupabaseClient<Database, SchemaNameOrClientOptions, SchemaName, Schema, ClientOptions>
Properties
Protected Optional access
Type declaration
Returns Promise<null | string>
auth
+
Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies.
+Protected auth
Protected Optional changed
Protected Optional fetch
Type declaration
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Protected functions
Protected headers
realtime
Protected realtime
Protected rest
storage
+
Supabase Storage allows you to manage user-generated content, such as photos or videos.
+Protected storage
Protected storage
Protected supabase
Protected supabase
Accessors
functions
- +
Supabase Functions allows you to deploy and invoke edge functions.
+Returns FunctionsClient
Methods
Private _get
Returns Promise<null | string>
Private _handle
Parameters
event: AuthChangeEvent
source: "CLIENT" | "STORAGE"
Optional token: string
Returns void
Private _init
Parameters
options: RealtimeClientOptions
Returns RealtimeClient
Private _init
Parameters
__namedParameters: SupabaseAuthClientOptions
Optional headers: Record<string, string>
Optional fetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Returns SupabaseAuthClient
Private _listen
Returns { data: { subscription: Subscription } }
data: { subscription: Subscription }
subscription: Subscription
channel
- +
Creates a Realtime channel with Broadcast, Presence, and Postgres Changes.
+Parameters
name: string
+The name of the Realtime channel.
+opts: RealtimeChannelOptions = ...
+The options to pass to the Realtime channel.
+
Returns RealtimeChannel
from
- +
Perform a query on a table or a view.
+Type Parameters
TableName extends string
Table extends GenericTable
Parameters
relation: TableName
+The table or view name to query
+
Returns default<ClientOptions, Schema, Table, TableName, Table extends { Relationships: R } ? R : unknown>
- +
Perform a query on a table or a view.
+Type Parameters
ViewName extends string
View extends GenericView
Parameters
relation: ViewName
+The table or view name to query
+
Returns default<ClientOptions, Schema, View, ViewName, View extends { Relationships: R } ? R : unknown>
get
- +
Returns all Realtime channels.
+Returns RealtimeChannel[]
remove
- +
Unsubscribes and removes all Realtime channels from Realtime client.
+Returns Promise<("error" | "ok" | "timed out")[]>
remove
- +
Unsubscribes and removes Realtime channel from Realtime client.
+Parameters
channel: RealtimeChannel
+The name of the Realtime channel.
+
Returns Promise<"error" | "ok" | "timed out">
rpc
- +
Perform a function call.
+Type Parameters
FnName extends string
Fn extends GenericFunction
Parameters
fn: FnName
+The function name to call
+args: Fn["Args"] = {}
+The arguments to pass to the function call
+options: { count?: "exact" | "planned" | "estimated"; get?: boolean; head?: boolean } = {}
+Named parameters
+Optional count?: "exact" | "planned" | "estimated"
+Count algorithm to use to count rows returned by the +function. Only applicable for set-returning +functions.
+
+"exact": Exact but slow count algorithm. Performs aCOUNT(*)under the +hood.
+"planned": Approximated but fast count algorithm. Uses the Postgres +statistics under the hood.
+"estimated": Uses exact count for low numbers and planned count for high +numbers.Optional get?: boolean
+When set to
+true, the function will be called with +read-only access mode.Optional head?: boolean
+When set to
+true,datawill not be returned. +Useful if you only need the count.
Returns default<ClientOptions, Schema, Fn["Returns"] extends any[] ? any[any][number] extends Record<string, unknown> ? any[any] : never : never, Fn["Returns"], FnName, null, "RPC">
schema
- +
Select a schema to query or perform an function (rpc) call.
+The schema needs to be on the list of exposed schemas inside Supabase.
+Type Parameters
DynamicSchema extends string
Parameters
schema: DynamicSchema
+The schema to query
+
Returns default<Database, ClientOptions, DynamicSchema, Database[DynamicSchema] extends GenericSchema ? any[any] : any>
Generated using TypeDoc
Class WebSocketFactory
Hierarchy
- WebSocketFactory
Index
Constructors
Properties
Methods
Constructors
constructor
Returns WebSocketFactory
Properties
Static Private detect
Methods
Static create
Parameters
url: string | URL
Optional protocols: string | string[]
Returns WebSocketLike
Static get
Returns { CLOSED: number; CLOSING: number; CONNECTING: number; OPEN: number; prototype: WebSocket }
Readonly CLOSED: number
Readonly CLOSING: number
Readonly CONNECTING: number
Readonly OPEN: number
prototype: WebSocket
Static is
Returns boolean
Generated using TypeDoc
Enumeration FunctionRegion
Generated using TypeDoc
Enumeration REALTIME_LISTEN_TYPES
Generated using TypeDoc
Enumeration REALTIME_POSTGRES_CHANGES_LISTEN_EVENT
Generated using TypeDoc
Enumeration REALTIME_PRESENCE_LISTEN_EVENTS
Generated using TypeDoc
Enumeration REALTIME_SUBSCRIBE_STATES
Generated using TypeDoc
@supabase/supabase-js
+
+
+
+Custom
+
+
supabase-js - Isomorphic JavaScript Client for Supabase.
+
+-
+
- Documentation: https://supabase.com/docs/reference/javascript/start +
- TypeDoc: https://supabase.github.io/supabase-js/v2/ +
+
+
+
+
+
+ Usage
+ +First of all, you need to install the library:
+npm install @supabase/supabase-js
+Then you're able to import the library and establish the connection with the database:
+import { createClient } from '@supabase/supabase-js'
// Create a single supabase client for interacting with your database
const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')
+UMD
+ +You can use plain <script>s to import supabase-js from CDNs, like:
<script src="https://cdn.jsdelivr.net/npm/@supabase/supabase-js@2"></script>
+or even:
+<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
+Then you can use it from a global supabase variable:
<script>
const { createClient } = supabase
const _supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')
console.log('Supabase Instance: ', _supabase)
// ...
</script>
+ESM
+ +You can use <script type="module"> to import supabase-js from CDNs, like:
<script type="module">
import { createClient } from 'https://cdn.jsdelivr.net/npm/@supabase/supabase-js/+esm'
const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')
console.log('Supabase Instance: ', supabase)
// ...
</script>
+Deno
+ +You can use supabase-js in the Deno runtime via JSR:
+import { createClient } from 'jsr:@supabase/supabase-js@2'
+Custom fetch implementation
+
+supabase-js uses the cross-fetch library to make HTTP requests, but an alternative fetch implementation can be provided as an option. This is most useful in environments where cross-fetch is not compatible, for instance Cloudflare Workers:
import { createClient } from '@supabase/supabase-js'
// Provide a custom `fetch` implementation as an option
const supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {
global: {
fetch: (...args) => fetch(...args),
},
})
+Support Policy
+ +This section outlines the scope of support for various runtime environments in Supabase JavaScript client.
+ + +Node.js
+ +We only support Node.js versions that are in Active LTS or Maintenance status as defined by the official Node.js release schedule. This means we support versions that are currently receiving long-term support and critical bug fixes.
+When a Node.js version reaches end-of-life and is no longer in Active LTS or Maintenance status, Supabase will drop it in a minor release, and this won't be considered a breaking change.
+ + +Deno
+ +We support Deno versions that are currently receiving active development and security updates. We follow the official Deno release schedule and only support versions from the stable and lts release channels.
When a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in a minor release, and this won't be considered a breaking change.
+ + +Important Notes
+ +-
+
- Experimental features: Features marked as experimental may be removed or changed without notice +
Testing
+ + + +Unit Testing
+ +npm test
+Integration Testing
+ +supabase start
npm run test:integration
+Expo Testing
+ +The project includes Expo integration tests to ensure compatibility with React Native environments.
+ + +Next.js Testing
+ +The project includes Next.js integration tests to ensure compatibility with React SSR environments.
+ + +Deno Testing
+ +The project includes Deno integration tests to ensure compatibility with Deno runtime.
+ + +Bun Testing
+ +The project includes Bun integration tests to ensure compatibility with Bun runtime.
+ + +CI/CD Testing
+ +When running on CI, the tests automatically use the latest dependencies from the root project. The CI pipeline:
+-
+
- Builds the main project with current dependencies +
- Creates a package archive (
.tgz) with the latest versions
+ - Uses this archive in Expo, Next.js, and Deno tests to ensure consistency +
Local Development
+ +For local development of Expo, Next.js, and Deno tests, you can update dependencies using automated scripts:
+# Update all test dependencies at once
npm run update:test-deps
# Or update specific test environments:
npm run update:test-deps:expo # Expo tests only
npm run update:test-deps:next # Next.js tests only
npm run update:test-deps:deno # Deno tests only
npm run update:test-deps:bun # Bun tests only
+Note: The CI automatically handles dependency synchronization, so manual updates are only needed for local development and testing.
+ + +Badges
+ +
Generated using TypeDoc
Interface AMREntry
+
An authentication methord reference (AMR) entry.
+An entry designates what method was used by the user to verify their +identity and at what time.
+Hierarchy
- AMREntry
Index
Properties
method
+
Authentication method name.
+timestamp
+
Timestamp when the method was successfully used. Represents number of +seconds since 1st January 1970 (UNIX epoch) in UTC.
+Generated using TypeDoc
Interface AdminUserAttributes
Hierarchy
- Omit<UserAttributes, "data">
- AdminUserAttributes
Index
Properties
Optional app_
+
A custom data object to store the user's application specific metadata. This maps to the auth.users.app_metadata column.
Only a service role can modify.
+The app_metadata should be a JSON object that includes app-specific info, such as identity providers, roles, and other
+access control information.
Optional ban_
+
Determines how long a user is banned for.
+The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix. +Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
+For example, some possible durations include: '300ms', '2h45m'.
+Setting the ban duration to 'none' lifts the ban on the user.
+Optional email
+
The user's email.
+Optional email_
+
Confirms the user's email address if set to true.
+Only a service role can modify.
+Optional id
+
The id for the user.
Allows you to overwrite the default id set for the user.
Optional nonce
+
The nonce sent for reauthentication if the user's password is to be updated.
+Call reauthenticate() to obtain the nonce first.
+Optional password
+
The user's password.
+Optional password_
+
The password_hash for the user's password.
Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.
+Supports bcrypt, scrypt (firebase), and argon2 password hashes.
+Optional phone
+
The user's phone.
+Optional phone_
+
Confirms the user's phone number if set to true.
+Only a service role can modify.
+Optional role
+
The role claim set in the user's access token JWT.
When a user signs up, this role is set to authenticated by default. You should only modify the role if you need to provision several levels of admin access that have different permissions on individual columns in your database.
Setting this role to service_role is not recommended as it grants the user admin privileges.
Optional user_
+
A custom data object to store the user's metadata. This maps to the auth.users.raw_user_meta_data column.
The user_metadata should be a JSON object that includes user-specific info, such as their first and last name.
Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, +this attribute is used instead of UserAttributes data.
+Generated using TypeDoc
Interface AuthSession
Hierarchy
- AuthSession
Index
Properties
access_
+
The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.
+Optional expires_
+
A timestamp of when the token will expire. Returned when a login is confirmed.
+expires_
+
The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.
+Optional provider_
+
The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.
+Optional provider_
+
The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.
+refresh_
+
A one-time used refresh token that never expires.
+token_
user
+
When using a separate user storage, accessing properties of this object will throw an error.
+Generated using TypeDoc
Interface AuthUser
Hierarchy
- AuthUser
Index
Properties
Optional action_
app_
aud
Optional confirmation_
Optional confirmed_
created_
Optional deleted_
Optional email
Optional email_
Optional email_
Optional factors
id
Optional identities
Optional invited_
Optional is_
Optional is_
Optional last_
Optional new_
Optional new_
Optional phone
Optional phone_
Optional recovery_
Optional role
Optional updated_
user_
Generated using TypeDoc
Interface Factor
Generated using TypeDoc
Interface GenerateLinkOptions
Hierarchy
- GenerateLinkOptions
Index
Properties
Properties
Optional data
+
A custom data object to store the user's metadata. This maps to the auth.users.raw_user_meta_data column.
The data should be a JSON object that includes user-specific info, such as their first and last name.
Optional redirect
+
The URL which will be appended to the email link generated.
+Generated using TypeDoc
Interface GoTrueAdminMFAApi
+
Contains the full multi-factor authentication administration API.
+Hierarchy
- GoTrueAdminMFAApi
Index
Methods
Methods
delete
- +
Deletes a factor on a user. This will log the user out of all active +sessions if the deleted factor was verified.
+Parameters
params: AuthMFAAdminDeleteFactorParams
Returns Promise<AuthMFAAdminDeleteFactorResponse>
list
- +
Lists all factors associated to a user.
+Parameters
params: AuthMFAAdminListFactorsParams
Returns Promise<AuthMFAAdminListFactorsResponse>
Generated using TypeDoc
Interface GoTrueMFAApi
+
Contains the full multi-factor authentication API.
+Hierarchy
- GoTrueMFAApi
Index
Methods
challenge
- +
Prepares a challenge used to verify that a user has access to a MFA +factor.
+Parameters
params: MFAChallengeParams
Returns Promise<AuthMFAChallengeResponse>
challenge
- +
Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is +provided by the user by entering a code seen in their authenticator app.
+Parameters
params: MFAChallengeAndVerifyParams
Returns Promise<AuthMFAVerifyResponse>
enroll
- +
Starts the enrollment process for a new Multi-Factor Authentication (MFA) +factor. This method creates a new
+unverifiedfactor. +To verify a factor, present the QR code or secret to the user and ask them to add it to their +authenticator app. +The user has to enter the code from their authenticator app to verify it.Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to
+aal2.Parameters
params: MFAEnrollTOTPParams
Returns Promise<AuthMFAEnrollTOTPResponse>
Parameters
params: MFAEnrollPhoneParams
Returns Promise<AuthMFAEnrollPhoneResponse>
Parameters
params: MFAEnrollParams
Returns Promise<AuthMFAEnrollResponse>
get
- +
Returns the Authenticator Assurance Level (AAL) for the active session.
+-
+
aal1(ornull) means that the user's identity has been verified only +with a conventional login (email+password, OTP, magic link, social login, +etc.).
+aal2means that the user's identity has been verified both with a conventional login and at least one MFA factor.
+
Although this method returns a promise, it's fairly quick (microseconds) +and rarely uses the network. You can use this to check whether the current +user needs to be shown a screen to verify their MFA factors.
+Returns Promise<AuthMFAGetAuthenticatorAssuranceLevelResponse>
list
- +
Returns the list of MFA factors enabled for this user.
+Returns Promise<AuthMFAListFactorsResponse>
unenroll
- +
Unenroll removes a MFA factor. +A user has to have an
+aal2authenticator level in order to unenroll averifiedfactor.Parameters
params: MFAUnenrollParams
Returns Promise<AuthMFAUnenrollResponse>
verify
- +
Verifies a code against a challenge. The verification code is +provided by the user by entering a code seen in their authenticator app.
+Parameters
params: MFAVerifyParams
Returns Promise<AuthMFAVerifyResponse>
Generated using TypeDoc
Interface JWK
Generated using TypeDoc
Interface Subscription
Hierarchy
- Subscription
Index
Properties
Methods
Properties
id
+
The subscriber UUID. This will be set by the client.
+Methods
callback
- +
The function to call every time there is an event. eg: (eventName) => {}
+Parameters
event: AuthChangeEvent
session: null | AuthSession
Returns void
unsubscribe
- +
Call this to remove the listener.
+Returns void
Generated using TypeDoc
Interface UserAppMetadata
Generated using TypeDoc
Interface UserAttributes
Hierarchy
- UserAttributes
Index
Properties
Optional data
+
A custom data object to store the user's metadata. This maps to the auth.users.raw_user_meta_data column.
The data should be a JSON object that includes user-specific info, such as their first and last name.
Optional email
+
The user's email.
+Optional nonce
+
The nonce sent for reauthentication if the user's password is to be updated.
+Call reauthenticate() to obtain the nonce first.
+Optional password
+
The user's password.
+Optional phone
+
The user's phone.
+Generated using TypeDoc
Interface UserIdentity
Generated using TypeDoc
Interface UserMetadata
Hierarchy
- UserMetadata
Indexable
Generated using TypeDoc
Interface VerifyEmailOtpParams
Hierarchy
- VerifyEmailOtpParams
Index
Properties
+
The user's email address.
+Optional options
Type declaration
Optional captcha
Token?: string +Verification token received when the user completes the captcha on the site.
+Optional redirect
To?: string +A URL to send the user to after they are confirmed.
+
token
+
The otp sent to the user's email address.
+type
+
The user's verification type.
+Generated using TypeDoc
Interface VerifyMobileOtpParams
Hierarchy
- VerifyMobileOtpParams
Index
Properties
Optional options
Type declaration
Optional captcha
Token?: string +Verification token received when the user completes the captcha on the site.
+Optional redirect
To?: string +A URL to send the user to after they are confirmed.
+
phone
+
The user's phone number.
+token
+
The otp sent to the user's phone number.
+type
+
The user's verification type.
+Generated using TypeDoc
Interface VerifyTokenHashParams
Generated using TypeDoc
Interface WebSocketLike
Hierarchy
- WebSocketLike
Index
Properties
Readonly CLOSED
Readonly CLOSING
Readonly CONNECTING
Readonly OPEN
Optional binary
Optional buffered
Optional extensions
onclose
onerror
onmessage
onopen
Readonly protocol
Readonly ready
Readonly url
Methods
add
Parameters
type: string
listener: EventListener
Returns void
close
Parameters
Optional code: number
Optional reason: string
Returns void
Optional dispatch
Parameters
event: Event
Returns boolean
remove
Parameters
type: string
listener: EventListener
Returns void
send
Parameters
data: string | ArrayBufferLike | ArrayBufferView | Blob
Returns void
Generated using TypeDoc
Interface SupabaseAuthClientOptions
Hierarchy
- AuthClientOptions
- SupabaseAuthClientOptions
Index
Properties
Optional auto
Optional debug
Optional detect
Optional fetch
Type declaration
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Optional flow
Optional has
+
Set to "true" if there is a custom authorization header set globally.
+Optional headers
Type declaration
[key: string]: string
Optional lock
+
Provide your own locking mechanism based on the environment. By default no locking is done at this time.
+Optional persist
Optional storage
Optional storage
Optional url
Optional user
+
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.
Generated using TypeDoc
@supabase/supabase-js
Generated using TypeDoc
Module index
Index
References
Enumerations
Classes
- Auth
Api Error - Auth
Error - Auth
Implicit Grant Redirect Error - Auth
Invalid Credentials Error - Auth
Invalid Jwt Error - Auth
Invalid Token Response Error - AuthPKCEGrant
Code Exchange Error - Auth
Retryable Fetch Error - Auth
Session Missing Error - Auth
Unknown Error - Auth
Weak Password Error - Custom
Auth Error - Functions
Error - Functions
Fetch Error - Functions
Http Error - Functions
Relay Error - Go
True Admin Api - Go
True Client - Navigator
Lock Acquire Timeout Error - Postgrest
Error - Realtime
Channel - Realtime
Client - Realtime
Presence - Supabase
Client - Web
Socket Factory
Interfaces
Type Aliases
- Auth
Change Event - Auth
Change EventMFA - Auth
Flow Type - AuthMFAAdmin
Delete Factor Params - AuthMFAAdmin
Delete Factor Response - AuthMFAAdmin
List Factors Params - AuthMFAAdmin
List Factors Response - AuthMFAChallenge
Response - AuthMFAEnroll
Phone Response - AuthMFAEnroll
Response - AuthMFAEnrollTOTPResponse
- AuthMFAGet
Authenticator Assurance Level Response - AuthMFAList
Factors Response - AuthMFAUnenroll
Response - AuthMFAVerify
Response - Auth
Otp Response - Auth
Response - Auth
Response Password - Auth
Token Response - Auth
Token Response Password - Authenticator
Assurance Levels - Call
Refresh Token Result - Email
Otp Type - Function
Invoke Options - Generate
Email Change Link Params - Generate
Invite Or Magiclink Params - Generate
Link Params - Generate
Link Properties - Generate
Link Response - Generate
Link Type - Generate
Recovery Link Params - Generate
Signup Link Params - Go
True Client Options - Initialize
Result - Jwt
Header - Jwt
Payload - Lock
Func - MFAChallenge
And Verify Params - MFAChallenge
Params - MFAEnroll
Params - MFAEnroll
Phone Params - MFAEnrollTOTPParams
- MFAUnenroll
Params - MFAVerify
Params - Mobile
Otp Type - OAuth
Response - Page
Params - Pagination
- Postgrest
Maybe Single Response - Postgrest
Response - Postgrest
Single Response - Provider
- Realtime
Channel Options - Realtime
Channel Send Response - Realtime
Client Options - Realtime
Message - Realtime
Postgres Changes Filter - Realtime
Postgres Changes Payload - Realtime
Postgres Delete Payload - Realtime
Postgres Insert Payload - Realtime
Postgres Update Payload - Realtime
Presence Join Payload - Realtime
Presence Leave Payload - Realtime
Presence State - Realtime
Remove Channel Response - Required
Claims - Resend
Params - SSOResponse
- Sign
In Anonymously Credentials - Sign
In With Id Token Credentials - Sign
In WithOAuth Credentials - Sign
In With Password Credentials - Sign
In With Passwordless Credentials - Sign
In WithSSO - Sign
Out - Sign
Out Scope - Sign
Up With Password Credentials - Solana
Wallet - Solana
Web3 Credentials - Supported
Storage - User
Response - Verify
Otp Params - Weak
Password - Weak
Password Reasons - Web3
Credentials
Variables
Functions
References
Query
Re-exports QueryDataQuery
Re-exports QueryErrorQuery
Re-exports QueryResultSession
Renames and re-exports AuthSessionSupabase
Re-exports SupabaseClientOptionsUser
Renames and re-exports AuthUserType Aliases
Auth
Auth
Auth
AuthMFAAdmin
Type declaration
id: string
+ID of the MFA factor to delete.
+user
Id: string +ID of the user whose factor is being deleted.
+
AuthMFAAdmin
AuthMFAAdmin
Type declaration
user
Id: string +ID of the user.
+
AuthMFAAdmin
AuthMFAChallenge
AuthMFAEnroll
AuthMFAEnroll
AuthMFAEnrollTOTPResponse
AuthMFAGet
AuthMFAList
AuthMFAUnenroll
AuthMFAVerify
Auth
+
AuthOtpResponse is returned when OTP is used.
+{@see AuthResponse}
+Auth
Auth
Auth
Auth
Authenticator
Call
Email
Function
Type declaration
Optional body?: File | Blob | ArrayBuffer | FormData | ReadableStream<Uint8Array> | Record<string, any> | string
+The body of the request.
+Optional headers?: {}
+Object representing the headers to send with the request.
+[key: string]: string
Optional method?: "POST" | "GET" | "PUT" | "PATCH" | "DELETE"
+The HTTP verb of the request
+Optional region?: FunctionRegion
+The Region to invoke the function in.
+
Generate
Type declaration
email: string
+The user's email
+new
Email: string +The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.
+Optional options?: Pick<GenerateLinkOptions, "redirectTo">
type: "email_change_current" | "email_change_new"
Generate
Type declaration
email: string
+The user's email
+Optional options?: Pick<GenerateLinkOptions, "data" | "redirectTo">
type: "invite" | "magiclink"
Generate
Generate
+
The properties related to the email link generated
+Type declaration
action_
link: string +The email link to send to the user. +The action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}
+email_
otp: string +The raw email OTP. +You should send this in the email if you want your users to verify using an OTP instead of the action link.
+hashed_
token: string +The hashed token appended to the action link.
+redirect_
to: string +The URL appended to the action link.
+verification_
type: GenerateLinkType +The verification type that the email link is associated to.
+
Generate
Generate
Generate
Type declaration
email: string
+The user's email
+Optional options?: Pick<GenerateLinkOptions, "redirectTo">
type: "recovery"
Generate
Type declaration
email: string
Optional options?: Pick<GenerateLinkOptions, "data" | "redirectTo">
password: string
type: "signup"
Go
Type declaration
Optional auto
Refresh Token?: boolean Optional debug?: boolean | ((message: string, ...args: any[]) => void)
Optional detect
Session In Url?: boolean Optional fetch?: Fetch
Optional flow
Type?: AuthFlowType Optional has
Custom Authorization Header?: boolean +Set to "true" if there is a custom authorization header set globally.
+Optional headers?: {}
[key: string]: string
Optional lock?: LockFunc
+Provide your own locking mechanism based on the environment. By default no locking is done at this time.
+Optional persist
Session?: boolean Optional storage?: SupportedStorage
Optional storage
Key?: string Optional url?: string
Optional user
Storage?: SupportedStorage +Stores the user object in a separate storage location from the rest of the session data. When non-null,
+storagewill only store a JSON object containing the access and refresh token and some adjacent metadata, whileuserStoragewill only contain the user object under the keystorageKey + '-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 usegetUser()to fetch a user object in those scenarios.
Initialize
Type declaration
error: AuthError | null
Jwt
Type declaration
alg: "RS256" | "ES256" | "HS256"
kid: string
typ: string
Jwt
Lock
Type declaration
- +
Provide your own global lock implementation instead of the default +implementation. The function should acquire a lock for the duration of the +
+fnasync function, such that no other client instances will be able to +hold it at the same time.Type Parameters
R
Parameters
name: string
+Name of the lock to be acquired.
+acquireTimeout: number
+If negative, no timeout should occur. If positive it + should throw an Error with an
+isAcquireTimeout+ property set to true if the operation fails to be + acquired after this much time (ms).fn: (() => Promise<R>)
+The operation to execute when the lock is acquired.
+Returns Promise<R>
Returns Promise<R>
MFAChallenge
Type declaration
code: string
+Verification code provided by the user.
+factor
Id: string +ID of the factor being verified. Returned in enroll().
+
MFAChallenge
Type declaration
Optional channel?: "sms" | "whatsapp"
+Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors
+factor
Id: string +ID of the factor to be challenged. Returned in enroll().
+
MFAEnroll
MFAEnroll
Type declaration
factor
Type: "phone" +The type of factor being enrolled.
+Optional friendly
Name?: string +Human readable name assigned to the factor.
+phone: string
+Phone number associated with a factor. Number should conform to E.164 format
+
MFAEnrollTOTPParams
Type declaration
factor
Type: "totp" +The type of factor being enrolled.
+Optional friendly
Name?: string +Human readable name assigned to the factor.
+Optional issuer?: string
+Domain which the user is enrolled with.
+
MFAUnenroll
Type declaration
factor
Id: string +ID of the factor being unenrolled.
+
MFAVerify
Type declaration
challenge
Id: string +ID of the challenge being verified. Returned in challenge().
+code: string
+Verification code provided by the user.
+factor
Id: string +ID of the factor being verified. Returned in enroll().
+
Mobile
OAuth
Page
Type declaration
Optional page?: number
+The page number
+Optional per
Page?: number +Number of items returned per page
+
Pagination
Type declaration
[key: string]: any
last
Page: number next
Page: number | null total: number
Postgrest
Type Parameters
T
Postgrest
Type Parameters
T
Postgrest
Type Parameters
T
Provider
+
One of the providers supported by GoTrue.
+Realtime
Type declaration
config: { broadcast?: { ack?: boolean; self?: boolean }; presence?: { enabled?: boolean; key?: string }; private?: boolean }
Optional broadcast?: { ack?: boolean; self?: boolean }
+self option enables client to receive message it broadcast +ack option instructs server to acknowledge that broadcast message was received
+Optional ack?: boolean
Optional self?: boolean
Optional presence?: { enabled?: boolean; key?: string }
+key option is used to track presence payload across clients
+Optional enabled?: boolean
Optional key?: string
Optional private?: boolean
+defines if the channel is private or not and if RLS policies will be used to check data
+
Realtime
Realtime
Type declaration
Optional decode?: Function
Optional encode?: Function
Optional fetch?: Fetch
Optional headers?: {}
[key: string]: string
Optional heartbeat
Interval Ms?: number Optional log
Level?: LogLevel Optional log_
level?: LogLevel Optional logger?: Function
Optional params?: {}
[key: string]: any
Optional reconnect
After Ms?: Function Optional timeout?: number
Optional transport?: WebSocketLikeConstructor
Optional worker?: boolean
Optional worker
Url?: string access
Token?:function Returns Promise<null | string>
Realtime
Type declaration
event: string
Optional join_
ref?: string payload: any
ref: string
topic: string
Realtime
Type Parameters
T extends `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT}`
Type declaration
event: T
+The type of database change to listen to.
+Optional filter?: string
+Receive database changes when filter is matched.
+schema: string
+The database schema to listen to.
+Optional table?: string
+The database table to listen to.
+
Realtime
Type Parameters
T extends {}
Realtime
Type Parameters
T extends {}
Realtime
Type Parameters
T extends {}
Realtime
Type Parameters
T extends {}
Realtime
Type Parameters
T extends {}
Type declaration
current
Presences: Presence<T>[] event: `${JOIN}`
key: string
new
Presences: Presence<T>[]
Realtime
Type Parameters
T extends {}
Type declaration
current
Presences: Presence<T>[] event: `${LEAVE}`
key: string
left
Presences: Presence<T>[]
Realtime
Type Parameters
T extends {} = {}
Type declaration
[key: string]: Presence<T>[]
Realtime
Required
Type declaration
aal: AuthenticatorAssuranceLevels
aud: string | string[]
exp: number
iat: number
iss: string
role: string
session_
id: string sub: string
Resend
SSOResponse
Sign
Type declaration
Optional options?: { captchaToken?: string; data?: object }
Optional captcha
Token?: string +Verification token received when the user completes the captcha on the site.
+Optional data?: object
+A custom data object to store the user's metadata. This maps to the
+auth.users.raw_user_meta_datacolumn.The
+datashould be a JSON object that includes user-specific info, such as their first and last name.
Sign
Type declaration
Optional access_
token?: string +If the ID token contains an
+at_hashclaim, then the hash of this value is compared to the value in the ID token.Optional nonce?: string
+If the ID token contains a
+nonceclaim, then the hash of this value is compared to the value in the ID token.Optional options?: { captchaToken?: string }
Optional captcha
Token?: string +Verification token received when the user completes the captcha on the site.
+
provider: "google" | "apple" | "azure" | "facebook" | "kakao" | string & {}
+Provider name or OIDC
+issvalue identifying which provider should be used to verify the provided token. Supported names:google,apple,azure,facebook,kakao,keycloak(deprecated).token: string
+OIDC ID token issued by the specified provider. The
+issclaim in the ID token must match the supplied provider. Some ID tokens contain anat_hashwhich require that you provide anaccess_tokenvalue to be accepted properly. If the token contains anonceclaim you must supply the nonce used to obtain the ID token.
Sign
Type declaration
Optional options?: { queryParams?: {}; redirectTo?: string; scopes?: string; skipBrowserRedirect?: boolean }
Optional query
Params?: {} +An object of query params
+[key: string]: string
Optional redirect
To?: string +A URL to send the user to after they are confirmed.
+Optional scopes?: string
+A space-separated list of scopes granted to the OAuth application.
+Optional skip
Browser Redirect?: boolean +If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider.
+
provider: Provider
+One of the providers supported by GoTrue.
+
Sign
Sign
Sign
Sign
Type declaration
Optional scope?: "global" | "local" | "others"
+Determines which sessions should be +logged out. Global means all +sessions by this account. Local +means only this session. Others +means all other sessions except the +current one. When using others, +there is no sign-out event fired on +the current session!
+
Sign
Sign
Solana
Type declaration
Optional public
Key?: { toBase58: any } | null sign
In?:function Parameters
Rest ...inputs: SolanaSignInInput[]
Returns Promise<SolanaSignInOutput | SolanaSignInOutput[]>
sign
Message?:function Parameters
message: Uint8Array
Optional encoding: string
Returns undefined | Promise<Uint8Array>
Solana
Supported
User
Verify
Weak
Type declaration
message: string
reasons: WeakPasswordReasons[]
Weak
Web3
Variables
Const Auth
Const Auth
Const REALTIME_
Const SIGN_
Const lock
Type declaration
debug: boolean
Functions
create
- +
Creates a new Supabase Client.
+Type Parameters
Database = any
SchemaNameOrClientOptions extends string | { PostgrestVersion: string } = "public" extends Exclude<keyof Database, "__InternalSupabase"> ? "public" : string & Exclude<keyof Database, "__InternalSupabase">
SchemaName extends string = SchemaNameOrClientOptions extends string & Exclude<keyof Database, "__InternalSupabase"> ? SchemaNameOrClientOptions : "public" extends Exclude<keyof Database, "__InternalSupabase"> ? "public" : string & Exclude<Exclude<keyof Database, "__InternalSupabase">, "__InternalSupabase">
Parameters
supabaseUrl: string
supabaseKey: string
Optional options: SupabaseClientOptions<SchemaName>
Returns SupabaseClient<Database, SchemaNameOrClientOptions, SchemaName, Omit<Database, "__InternalSupabase">[SchemaName] extends GenericSchema ? any[any] : never, SchemaNameOrClientOptions extends string & Exclude<keyof Database, "__InternalSupabase"> ? Database extends { __InternalSupabase: { PostgrestVersion: string } } ? Database["__InternalSupabase"] : { PostgrestVersion: "12" } : SchemaNameOrClientOptions extends { PostgrestVersion: string } ? SchemaNameOrClientOptions : never>
is
Parameters
error: unknown
Returns error is AuthApiError
is
Parameters
error: unknown
Returns error is AuthError
is
Parameters
error: any
Returns error is AuthImplicitGrantRedirectError
is
Parameters
error: unknown
Returns error is AuthRetryableFetchError
is
Parameters
error: any
Returns error is AuthSessionMissingError
is
Parameters
error: unknown
Returns error is AuthWeakPasswordError
navigator
- +
Implements a global exclusive lock using the Navigator LockManager API. It +is available on all browsers released after 2022-03-15 with Safari being the +last one to release support. If the API is not available, this function will +throw. Make sure you check availablility before configuring GoTrueClient.
+You can turn on debugging by setting the
+supabase.gotrue-js.locks.debug+local storage item totrue.Internals:
+Since the LockManager API does not preserve stack traces for the async +function passed in the
+requestmethod, a trick is used where acquiring the +lock releases a previously started promise to run the operation in thefn+function. The lock waits for that promise to finish (with or without error), +while the function will finally wait for the result anyway.Type Parameters
R
Parameters
name: string
+Name of the lock to be acquired.
+acquireTimeout: number
+If negative, no timeout. If 0 an error is thrown if + the lock can't be acquired without waiting. If positive, the lock acquire + will time out after so many milliseconds. An error is + a timeout if it has
+isAcquireTimeoutset to true.fn: (() => Promise<R>)
+The operation to run once the lock is acquired.
+Returns Promise<R>
Returns Promise<R>
process
- +
Implements a global exclusive lock that works only in the current process. +Useful for environments like React Native or other non-browser +single-process (i.e. no concept of "tabs") environments.
+Use {@link #navigatorLock} in browser environments.
+Type Parameters
R
Parameters
name: string
+Name of the lock to be acquired.
+acquireTimeout: number
+If negative, no timeout. If 0 an error is thrown if + the lock can't be acquired without waiting. If positive, the lock acquire + will time out after so many milliseconds. An error is + a timeout if it has
+isAcquireTimeoutset to true.fn: (() => Promise<R>)
+The operation to run once the lock is acquired.
+Returns Promise<R>
Returns Promise<R>
Generated using TypeDoc
Module lib/constants
Generated using TypeDoc
Module lib/fetch
Index
Functions
fetch
Parameters
supabaseKey: string
getAccessToken: (() => Promise<null | string>)
Returns Promise<null | string>
Optional customFetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Returns ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
resolve
Parameters
Optional customFetch: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
Returns ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)
Parameters
input: RequestInfo | URL
Optional init: RequestInit
Returns Promise<Response>
resolve
Returns any
Generated using TypeDoc
Module lib/helpers
Index
Functions
apply
Type Parameters
Database = any
SchemaName extends string = "public" extends keyof Database ? "public" : string & keyof Database
Parameters
options: SupabaseClientOptions<SchemaName>
defaults: SupabaseClientOptions<any>
Returns Required<SupabaseClientOptions<SchemaName>>
ensure
Parameters
url: string
Returns string
is
Returns boolean
uuid
Returns string
Generated using TypeDoc
Module lib/types
Index
Type Aliases
Fetch
Generic
Type declaration
Args: Record<string, unknown>
Returns: unknown
Generic
Type declaration
Relationships: GenericRelationship[]
Row: Record<string, unknown>
Generic
Type declaration
columns: string[]
foreign
Key Name: string Optional is
One To One?: boolean referenced
Columns: string[] referenced
Relation: string
Generic
Type declaration
Functions: Record<string, GenericFunction>
Tables: Record<string, GenericTable>
Views: Record<string, GenericView>
Generic
Type declaration
Insert: Record<string, unknown>
Relationships: GenericRelationship[]
Row: Record<string, unknown>
Update: Record<string, unknown>
Generic
Generic
Query
Type Parameters
T
Query
Query
+
Helper types for query results.
+Type Parameters
T
Supabase
Type Parameters
SchemaName
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 auto
Refresh Token?: 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 detect
Session In Url?: boolean +Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.
+Optional flow
Type?: 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.
+Optional persist
Session?: 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 storage
Key?: 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
+fetchimplementation.Optional headers?: Record<string, string>
+Optional headers for initializing the client.
+
Optional realtime?: RealtimeClientOptions
+Options passed to the realtime-js instance
+Optional storage?: StorageClientOptions
access
Token?:function - +
Optional function for using a third-party authentication system with +Supabase. The function should return an access token or ID token (JWT) by +obtaining it from the third-party auth client library. Note that this +function may be called concurrently and many times. Use memoization and +locking techniques if this is not supported by the client libraries.
+When set, the
+authnamespace of the Supabase client cannot be used. +Create another client if you wish to use Supabase Auth and third-party +authentications concurrently in the same application.Returns Promise<null | string>
Generated using TypeDoc
Module lib/version
Generated using TypeDoc
Error code associated with the error. Most errors coming from +HTTP responses will have a code, though some errors that occur +before a response is received will not have one present. In that +case {@link #status} will also be undefined.
+