CSRF-X Auth Library - v1.0.3
    Preparing search index...

    Interface EnvVars

    Environment variables required or optionally used by the authentication library.

    Only BASE_URL is mandatory. All other fields are optional but may be required
    by specific clients (e.g., {@link AuthClient} needs USER_EMAIL and USER_PASSWORD).

    // Minimal valid EnvVars
    { BASE_URL: "https://example.com" }

    // Full configuration
    {
      BASE_URL: "https://example.com",
      LOGIN_PATH: "signin",
      LOGOUT_PATH: "signout",
      USER_EMAIL: "admin@example.com",
      USER_PASSWORD: "secret123"
    }

    @0.1.1

    0.1.1

    interface EnvVars {
        BASE_URL: string;
        LOGIN_PATH?: string;
        LOGOUT_PATH?: string;
        USER_EMAIL?: string;
        USER_PASSWORD?: string;
    }
    Index

    Properties

    BASE_URL LOGIN_PATH? LOGOUT_PATH? USER_EMAIL? USER_PASSWORD?

    Properties

    BASE_URL: string

    Base URL of the target server.

    Must be a valid HTTP or HTTPS URL (e.g., http://localhost:3000 or https://api.example.com).
    This field is required; if missing, loadEnv will throw an error.

    LOGIN_PATH?: string

    Path to the login endpoint, relative to BASE_URL.

    "login"

    If provided, it must not be an empty string and must not contain ? or #.
    Leading slashes are automatically removed by EnvConfig.

    LOGOUT_PATH?: string

    Path to the logout endpoint, relative to BASE_URL.

    "logout"

    If provided, it must not be an empty string and must not contain ? or #.
    Leading slashes are automatically removed by EnvConfig.

    USER_EMAIL?: string

    User email address for authentication.

    If provided and non‑empty, it must be a syntactically valid email address
    (basic format local@domain.tld). Empty strings are treated as omitted.

    USER_PASSWORD?: string

    User password for authentication.

    If provided, it cannot be an empty string. No other validation is performed.

    Settings

    Member Visibility

    On This Page

    Properties