Nut - v1.0.0
    Preparing search index...

    Interface INUTClientOptions

    Options for RawNUTClient.

    interface INUTClientOptions {
        autoReconnect?: boolean;
        connectTimeout?: number;
        maxReconnectAttempts?: number;
        maxReconnectDelay?: number;
        password?: string;
        reconnectBackoff?: number;
        reconnectDelay?: number;
        timeout?: number;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    autoReconnect? connectTimeout? maxReconnectAttempts? maxReconnectDelay? password? reconnectBackoff? reconnectDelay? timeout? username?
    autoReconnect?: boolean

    Enable auto-reconnect on connection loss. Default: false

    connectTimeout?: number

    Timeout for initial TCP connection (ms). Default: 10000

    maxReconnectAttempts?: number

    Maximum number of reconnect attempts before giving up. Default: Infinity

    maxReconnectDelay?: number

    Maximum delay between reconnect attempts (ms). Default: 30000

    password?: string

    Password for authentication. Stored and re-sent automatically after reconnect.

    reconnectBackoff?: number

    Multiplier for exponential backoff. Default: 2

    reconnectDelay?: number

    Initial delay before reconnect attempt (ms). Default: 1000

    timeout?: number

    Default timeout for commands (ms). If not set or set to Infinity, commands have no timeout.

    username?: string

    Username for authentication. Stored and re-sent automatically after reconnect.

    Settings
    Member Visibility

    On This Page
    Properties