MELCloud & MELCloud Home API for Node.js - v48.2.0
    Preparing search index...

    Interface ClassicAPIConfig

    Configuration options for creating a MELCloud Classic API instance.

    interface ClassicAPIConfig {
        abortSignal?: AbortSignal;
        events?: LifecycleEvents;
        language?: string;
        locale?: string;
        logger?: Logger;
        password?: string;
        settingManager?: SettingManager;
        shouldResumeSessionInBackground?: boolean;
        shouldVerifySSL?: boolean;
        syncIntervalMinutes?: number | false;
        timezone?: string;
        transport?: TransportConfig;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignal

    Optional shutdown signal applied to every outgoing request.

    When the signal fires, all in-flight HTTP requests abort with a DOMException of name AbortError. Subsequent calls from the same client instance will also abort immediately. Use this to tie the SDK lifetime to a host process lifetime — e.g. pass the Homey app's shutdown signal so outstanding requests don't dangle across a reload.

    Structured-events callbacks invoked around SDK lifecycle moments. Useful to plug the SDK into a host observability stack (pino / winston / OpenTelemetry / custom metrics).

    language?: string

    Upstream account language code (e.g. 'en', 'fr').

    locale?: string

    BCP-47 locale tag for report chart labels (day-of-week, month names). Independent of languagelanguage controls upstream messages, locale controls how the SDK formats labels locally. Defaults to the runtime locale when unset.

    logger?: Logger

    Custom logger. Defaults to console.

    password?: string
    settingManager?: SettingManager

    External setting manager for persisting credentials and session data.

    shouldResumeSessionInBackground?: boolean

    Restore the persisted session in the background instead of awaiting it inside create(). Session probing and full logins can take tens of seconds on slow networks, which blows a host app's init budget (e.g. Homey's 30 s ready timeout). The lifecycle contract is unchanged — auto-sync arming, onAuthenticationLost, login backoff — it just runs off the critical path; isAuthenticated() may report false until the background restore lands.

    shouldVerifySSL?: boolean

    Whether to verify SSL certificates. Defaults to true.

    syncIntervalMinutes?: number | false

    Auto-sync timer in minutes. false disables the timer entirely (manual list() / fetch() only). Omit to use the subclass default (1 for Home, 5 for Classic).

    timezone?: string

    IANA timezone identifier (e.g. 'Europe/Paris').

    transport?: TransportConfig

    HTTP transport: pre-built HttpClient or build options.

    username?: string