ConnectionStatus: {
    available: boolean;
    message?: string;
    name: string;
    version?: string;
    [x: string]: unknown;
}

A simple object representing the connection status for a given backend.

Type declaration

  • [x: string]: unknown
  • available: boolean

    A simple yes/no flag for this backend being both a) reachable and b) available for requests.

  • Optional message?: string

    An optional message to provide to the client. Even when set, not all clients will show this.

  • name: string

    The name for this backend

    Remarks

    This may be presented to the user, you should keep it user-friendly.

  • Optional version?: string

    The current version of this backend. This is optional, and not all clients will show this, but still recommended.

Generated using TypeDoc