MELCloud & MELCloud Home API for Node.js - v23.3.3
    Preparing search index...

    Interface APIConfig

    Configuration options for creating a MELCloud API instance.

    interface APIConfig {
        autoSyncInterval?: number | null;
        language?: string;
        logger?: Logger;
        onSync?: OnSyncFunction;
        password?: string;
        settingManager?: SettingManager;
        shouldVerifySSL?: boolean;
        timezone?: string;
        username?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoSyncInterval? language? logger? onSync? password? settingManager? shouldVerifySSL? timezone? username?

    Properties

    autoSyncInterval?: number | null

    Interval in minutes between automatic syncs. Set to null to disable.

    language?: string

    Locale language code (e.g. 'en', 'fr').

    logger?: Logger

    Custom logger. Defaults to console.

    onSync?: OnSyncFunction

    Callback invoked after sync operations.

    password?: string
    settingManager?: SettingManager

    External setting manager for persisting credentials and session data.

    shouldVerifySSL?: boolean

    Whether to verify SSL certificates. Defaults to true.

    timezone?: string

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

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties