@supabase/server - v1.7.0
    Preparing search index...

    Variable ErrorsConst

    Errors: {
        MISSING_SUPABASE_URL: () => EnvError;
        MISSING_SECRET_KEY: (
            name: string,
            availableKeyNames?: readonly string[],
        ) => EnvError;
        MISSING_DEFAULT_SECRET_KEY: (
            availableKeyNames?: readonly string[],
        ) => EnvError;
        MISSING_PUBLISHABLE_KEY: (
            name: string,
            availableKeyNames?: readonly string[],
        ) => EnvError;
        MISSING_DEFAULT_PUBLISHABLE_KEY: (
            availableKeyNames?: readonly string[],
        ) => EnvError;
        MISSING_RESOURCE_SERVER: (runtime: string) => EnvError;
        MISSING_AUTHORIZATION_SERVER: () => EnvError;
        MISSING_CONNECTION_STRING: (middleware: string) => EnvError;
        MISSING_CREDENTIALS: (context: AuthFailureContext) => AuthError;
        UNUSABLE_CREDENTIAL: (
            context: Partial<AuthFailureContext> & { reason: string; hint: string },
        ) => AuthError;
        INVALID_API_KEY: (context: AuthFailureContext) => AuthError;
        INVALID_JWT: (
            context: Partial<AuthFailureContext> & {
                reason: string;
                hint: string;
                jwt?: Record<string, unknown>;
                cause?: unknown;
            },
        ) => AuthError;
        JWKS_NOT_CONFIGURED: (
            context?: Partial<AuthFailureContext> & { middleware?: string },
        ) => AuthError;
        JWKS_FETCH_FAILED: (
            context: Partial<AuthFailureContext> & {
                reason: string;
                cause?: unknown;
            },
        ) => AuthError;
        NO_KEYS_CONFIGURED: (
            context: AuthFailureContext & {
                mode: string;
                keyKind: "publishable" | "secret";
            },
        ) => AuthError;
        INVALID_CREDENTIALS: (context?: AuthFailureContext) => AuthError;
        CREATE_SUPABASE_CLIENT_ERROR: (options?: { cause?: unknown }) => AuthError;
        UNSUPPORTED_ROLE: (
            context: { requestedRole: unknown; supportedRoles: readonly string[] },
        ) => AuthError;
    } = ...

    Factory map for all error types. Keyed by error code constant, each entry returns a pre-configured EnvError or AuthError complete with hint, docs, and details.

    Type Declaration

    • MISSING_SUPABASE_URL: () => EnvError
    • MISSING_SECRET_KEY: (name: string, availableKeyNames?: readonly string[]) => EnvError
    • MISSING_DEFAULT_SECRET_KEY: (availableKeyNames?: readonly string[]) => EnvError
    • MISSING_PUBLISHABLE_KEY: (name: string, availableKeyNames?: readonly string[]) => EnvError
    • MISSING_DEFAULT_PUBLISHABLE_KEY: (availableKeyNames?: readonly string[]) => EnvError
    • MISSING_RESOURCE_SERVER: (runtime: string) => EnvError
    • MISSING_AUTHORIZATION_SERVER: () => EnvError
    • MISSING_CONNECTION_STRING: (middleware: string) => EnvError
    • MISSING_CREDENTIALS: (context: AuthFailureContext) => AuthError
    • UNUSABLE_CREDENTIAL: (
          context: Partial<AuthFailureContext> & { reason: string; hint: string },
      ) => AuthError
    • INVALID_API_KEY: (context: AuthFailureContext) => AuthError
    • INVALID_JWT: (
          context: Partial<AuthFailureContext> & {
              reason: string;
              hint: string;
              jwt?: Record<string, unknown>;
              cause?: unknown;
          },
      ) => AuthError
    • JWKS_NOT_CONFIGURED: (context?: Partial<AuthFailureContext> & { middleware?: string }) => AuthError
    • JWKS_FETCH_FAILED: (
          context: Partial<AuthFailureContext> & {
              reason: string;
              cause?: unknown;
          },
      ) => AuthError
    • NO_KEYS_CONFIGURED: (
          context: AuthFailureContext & {
              mode: string;
              keyKind: "publishable" | "secret";
          },
      ) => AuthError
    • INVALID_CREDENTIALS: (context?: AuthFailureContext) => AuthError
    • CREATE_SUPABASE_CLIENT_ERROR: (options?: { cause?: unknown }) => AuthError
    • UNSUPPORTED_ROLE: (
          context: { requestedRole: unknown; supportedRoles: readonly string[] },
      ) => AuthError
    throw Errors[MissingSupabaseURLError]()
    throw Errors[MissingPublishableKeyError]('mobile', ['default', 'web'])

    Settings

    Member Visibility