Interface BaseAPIConfig

Common configuration shared by all API clients.

interface BaseAPIConfig {
    autoSyncInterval?: number | null;
    logger?: Logger;
    onSync?: OnSyncFunction;
    password?: string;
    settingManager?: SettingManager;
    username?: string;
}

Hierarchy (View Summary)

Partial<LoginCredentials>
- BaseAPIConfig
  - APIConfig
  - HomeAPIConfig

Index

Properties

autoSyncInterval? logger? onSync? password? settingManager? username?

Properties

`Optional` `Readonly`autoSyncInterval

autoSyncInterval?: number | null

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

`Optional` `Readonly`logger

logger?: Logger

Custom logger. Defaults to console.

`Optional` `Readonly`onSync

onSync?: OnSyncFunction

Callback invoked after sync operations.

`Optional` `Readonly`password

password?: string

`Optional` `Readonly`settingManager

settingManager?: SettingManager

External setting manager for persisting credentials and session data.

`Optional` `Readonly`username

username?: string