Repository files navigation

• Documentation:https://supabase.com/docs/reference/javascript/start
• TypeDoc:https://supabase.github.io/supabase-js/v2/

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 databaseconstsupabase=createClient('https://xyzcompany.supabase.co','public-anon-key')

You can use plain<script>s to import supabase-js from CDNs, like:

<scriptsrc="https://cdn.jsdelivr.net/npm/@supabase/supabase-js@2"></script>

or even:

<scriptsrc="https://unpkg.com/@supabase/supabase-js@2"></script>

Then you can use it from a globalsupabase variable:

<script>const{ createClient}=supabaseconst_supabase=createClient('https://xyzcompany.supabase.co','public-anon-key')console.log('Supabase Instance: ',_supabase)// ...</script>

You can use<script type="module"> to import supabase-js from CDNs, like:

<scripttype="module">import{createClient}from'https://cdn.jsdelivr.net/npm/@supabase/supabase-js/+esm'constsupabase=createClient('https://xyzcompany.supabase.co','public-anon-key')console.log('Supabase Instance: ',supabase)// ...</script>

You can use supabase-js in the Deno runtime viaJSR:

import{createClient}from'jsr:@supabase/supabase-js@2'

supabase-js uses thecross-fetch library to make HTTP requests, but an alternativefetch implementation can be provided as an option. This is most useful in environments wherecross-fetch is not compatible, for instance Cloudflare Workers:

import{createClient}from'@supabase/supabase-js'// Provide a custom `fetch` implementation as an optionconstsupabase=createClient('https://xyzcompany.supabase.co','public-anon-key',{global:{fetch:(...args)=>fetch(...args),},})

This section outlines the scope of support for various runtime environments in Supabase JavaScript client.

We only support Node.js versions that are inActive LTS orMaintenance status as defined by theofficial 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 aminor release, andthis won't be considered a breaking change.

We support Deno versions that are currently receiving active development and security updates. We follow theofficial Deno release schedule and only support versions from thestable andlts release channels.

When a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in aminor release, andthis won't be considered a breaking change.

• Experimental features: Features marked as experimental may be removed or changed without notice

pnpmtest

supabase startpnpm run test:integration

The project includes Expo integration tests to ensure compatibility with React Native environments.

The project includes Next.js integration tests to ensure compatibility with React SSR environments.

The project includes Deno integration tests to ensure compatibility with Deno runtime.

The project includes Bun integration tests to ensure compatibility with Bun runtime.

When running on CI, the tests automatically use the latest dependencies from the root project. The CI pipeline:

1. Builds the main project with current dependencies
2. Creates a package archive (.tgz) with the latest versions
3. Uses this archive in Expo, Next.js, and Deno tests to ensure consistency

For local development of Expo, Next.js, and Deno tests, you can update dependencies using automated scripts:

# Update all test dependencies at oncenpm run update:test-deps# Or update specific test environments:npm run update:test-deps:expo# Expo tests onlynpm run update:test-deps:next# Next.js tests onlynpm run update:test-deps:deno# Deno tests onlynpm 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.