Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

setLanguage(lang)

function setLanguage(lang: SupportedLanguage | 'auto'): void;

Sets the module-level default language.

ArgumentDescription
langA supported language code or auto. Unsupported values fall back to en at runtime.

Use per-call language overrides instead of setLanguage() in request-scoped server code.

translateErrorCode(code, service, lang?)

function translateErrorCode(
  code: string | undefined,
  service: ErrorService,
  lang?: SupportedLanguage | 'auto',
): string;

Returns a translated string for a Supabase error code.

ArgumentDescription
codeThe Supabase error code. Empty, whitespace-only, or undefined values are treated as unknown_error.
serviceOne of auth, storage, realtime, database, or functions.
langOptional per-call language override. auto uses browser detection.

getCurrentLanguage()

function getCurrentLanguage(): SupportedLanguage;

Returns the current module-level default language.

getSupportedLanguages()

function getSupportedLanguages(): SupportedLanguage[];

Returns a copy of the supported language-code list.

isSupportedLanguage(lang)

function isSupportedLanguage(lang: string): lang is SupportedLanguage;

Runtime guard for supported language codes.

isSupportedService(service)

function isSupportedService(service: string): service is ErrorService;

Runtime guard for supported service names.

Constants And Types

import {
  SUPPORTED_LANGUAGES,
  SUPPORTED_SERVICES,
  type ErrorService,
  type SupportedLanguage,
  type TranslationStructure,
} from 'supabase-error-translator-js';