Interface BackendStatus

Result of detecting a backend's availability.

interface BackendStatus {
    status: SetupStatus;
    url?: string;
    containerName?: string;
    source?: "manual" | "docker-local" | "env-var" | "cloud";
    error?: string;
}

Properties

status url? containerName? source? error?

Properties

status

status: SetupStatus

Current status of the backend.

Optional url

url?: string

URL/connection string if the backend is reachable.

Optional containerName

containerName?: string

Docker container name if running via Docker.

Optional source

source?: "manual" | "docker-local" | "env-var" | "cloud"

How the backend was discovered.

Optional error

error?: string

Error message if status is 'error' or 'no_docker'.

Settings

Member Visibility

Theme

On This Page

statusurlcontainerNamesourceerror