@truenas/api-client
    Preparing search index...

    Interface CreateClientOptions

    Options for createTrueNasClient.

    interface CreateClientOptions {
        enabled: boolean;
        hostnames: string[];
        logger?: Logger;
        systemName?: string;
        uuid: string;
    }
    Index
    enabled hostnames logger? systemName? uuid
    enabled: boolean

    Initial connection gate. The client only opens a socket while this is true; flip it later via client.connection.setEnabled(). (The app maps its SystemState.Active -> true.)

    hostnames: string[]

    Hostnames to connect to. Order carries no precedence for version discovery (every hostname is asked at once); it only breaks ties when deciding which failure to report if none of them answer.

    logger?: Logger

    Optional logger; defaults to a no-op. Forwarded to version discovery and, through the client, to the connection.

    systemName?: string

    Optional system name (used only for log context).

    uuid: string

    System UUID.

    Settings
    Member Visibility

    On This Page
    Properties