Package Exports
- @supabase/supabase-js
- @supabase/supabase-js/dist/main
- @supabase/supabase-js/dist/main/index.js
- @supabase/supabase-js/dist/main/lib/helpers
- @supabase/supabase-js/dist/main/lib/helpers.js
- @supabase/supabase-js/dist/module/index.js
- @supabase/supabase-js/dist/module/lib/SupabaseAuthClient
- @supabase/supabase-js/dist/module/lib/SupabaseAuthClient.js
- @supabase/supabase-js/dist/module/lib/constants
- @supabase/supabase-js/dist/module/lib/constants.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@supabase/supabase-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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),
},
})
Testing
Unit Testing
pnpm test
Integration Testing
supabase start
pnpm 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.