\n\n## Usage\n\nFirst of all, you need to install the library:\n\n```sh\nnpm install @supabase/supabase-js\n```\n\nThen you're able to import the library and establish the connection with the database:\n\n```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key')\n```\n\n### UMD\n\nYou can use plain `\n```\n\nor even:\n\n```html\n\n```\n\nThen you can use it from a global `supabase` variable:\n\n```html\n\n```\n\n### ESM\n\nYou can use `\n```\n\n### Deno\n\nYou can use supabase-js in the Deno runtime via [JSR](https://jsr.io/@supabase/supabase-js):\n\n```js\nimport { createClient } from 'jsr:@supabase/supabase-js@2'\n```\n\n### Custom `fetch` implementation\n\n`supabase-js` uses the [`cross-fetch`](https://www.npmjs.com/package/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:\n\n```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Provide a custom `fetch` implementation as an option\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n global: {\n fetch: (...args) => fetch(...args),\n },\n})\n```\n\n## Support Policy\n\nThis section outlines the scope of support for various runtime environments in Supabase JavaScript client.\n\n### Node.js\n\nWe only support Node.js versions that are in **Active LTS** or **Maintenance** status as defined by the [official Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule). This means we support versions that are currently receiving long-term support and critical bug fixes.\n\nWhen 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**.\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped in version `2.79.0`.\n>\n> If you must use Node.js 18, please use version `2.78.0`, which is the last version that supported Node.js 18.\n\n### Deno\n\nWe support Deno versions that are currently receiving active development and security updates. We follow the [official Deno release schedule](https://docs.deno.com/runtime/fundamentals/stability_and_releases/) and only support versions from the `stable` and `lts` release channels.\n\nWhen 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**.\n\n### Browsers\n\nAll modern browsers are supported. We support browsers that provide native `fetch` API. For Realtime features, browsers must also support native `WebSocket` API.\n\n### Bun\n\nWe support Bun runtime environments. Bun provides native fetch support and is compatible with Node.js APIs. Since Bun does not follow a structured release schedule like Node.js or Deno, we support current stable versions of Bun and may drop support for older versions in minor releases without considering it a breaking change.\n\n### React Native\n\nWe support React Native environments with fetch polyfills provided by the framework. Since React Native does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Cloudflare Workers\n\nWe support Cloudflare Workers runtime environments. Cloudflare Workers provides native fetch support. Since Cloudflare Workers does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Important Notes\n\n- **Experimental features**: Features marked as experimental may be removed or changed without notice\n\n## Known Build Warnings\n\n### `UNUSED_EXTERNAL_IMPORT` in Vite / Rollup / Nuxt\n\nWhen bundling your app, you may see warnings like:\n\n```\n\"PostgrestError\" is imported from external module \"@supabase/postgrest-js\" but never used in \"...supabase-js/dist/index.mjs\".\n\"FunctionRegion\", \"FunctionsError\", \"FunctionsFetchError\", \"FunctionsHttpError\" and \"FunctionsRelayError\" are imported from external module \"@supabase/functions-js\" but never used in \"...\".\n```\n\n**This is a false positive — your bundle is fine.** Here is why it happens:\n\n`@supabase/supabase-js` re-exports `PostgrestError`, `FunctionsError`, and related symbols so you can import them directly from `@supabase/supabase-js`. However, our build tool merges all imports from the same package into a single import statement in the built output:\n\n```js\n// dist/index.mjs (simplified)\nimport { PostgrestClient, PostgrestError } from '@supabase/postgrest-js'\n// ^ used internally ^ re-exported for you\n```\n\nYour bundler checks which names from that import are used _in the code body_, and flags `PostgrestError` as unused because it only appears in an `export` statement — not called or assigned. The export itself is the usage, but downstream bundlers don't track this correctly. This is a known Rollup/Vite limitation with re-exported external imports.\n\n**Nothing is broken.** Tree-shaking and bundle size are unaffected.\n\nTo suppress the warning:\n\n**Vite / Rollup (`vite.config.js` or `rollup.config.js`):**\n\n```js\nexport default {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n}\n```\n\n**Nuxt (`nuxt.config.ts`):**\n\n```ts\nexport default defineNuxtConfig({\n vite: {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n },\n})\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](../../../CONTRIBUTING.md) for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n### Building\n\n```bash\n# From the monorepo root\nnpx nx build supabase-js\n\n# Or with watch mode for development\nnpx nx build supabase-js --watch\n```\n\n### Testing\n\nThere's a complete guide on how to set up your environment for running locally the `supabase-js` integration tests. Please refer to [TESTING.md](./TESTING.md).\n\n## Badges\n\n[](https://coveralls.io/github/supabase/supabase-js?branch=master)","users":{}}
![\"Supabase](\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg\"){kind=logo}
\n