@iobroker/types 7.2.2 → 7.2.3-alpha.1-20260621-61726ea22

package/build/config.d.ts

@@ -46,20 +46,33 @@ interface JsonlOptions {
     };
 }
 
+/** Configuration of a database connection (objects or states) */
 export interface DatabaseOptions {
     /** Possible values: 'file' - [port 9001], 'jsonl' - [port 9001], 'redis' - [port 6379 or 26379 for sentinel]. */
     type: 'jsonl' | 'file' | 'redis';
+    /** Name of the sentinel master to connect to */
     sentinelName?: string;
+    /** Host name(s) or IP address(es) of the database server */
     host: string | string[];
+    /** Port(s) of the database server */
     port: number | number[];
+    /** Maximum time in milliseconds to wait for a connection to be established */
     connectTimeout: number;
+    /** Interval in milliseconds between flushing the in-memory database to file */
     writeFileInterval: number;
+    /** Directory where the database files are stored, relative to the controller dir */
     dataDir?: string;
+    /** Low-level connection options passed to the database driver */
     options: {
+        /** Password used to authenticate against the database */
         auth_pass: string;
+        /** Maximum delay in milliseconds between reconnection attempts */
         retry_max_delay: number;
+        /** Maximum number of reconnection attempts */
         retry_max_count: number;
+        /** Redis database index to use */
         db: number;
+        /** IP stack to use (4 for IPv4, 6 for IPv6) */
         family: number;
         /** As soon as the tls property is defined, redis will try to connect via tls (currently only for redis) */
         tls?: {
@@ -73,14 +86,19 @@ export interface DatabaseOptions {
             cert?: string;
         };
     };
+    /** Backup configuration for the database */
     backup: DatabaseBackupOptions;
+    /** Options specific to the JSONL database backend */
     jsonlOptions: JsonlOptions;
 }
 
+/** Configuration of the objects database connection */
 export interface ObjectsDatabaseOptions extends DatabaseOptions {
+    /** Disable the in-memory file cache for objects */
     noFileCache: boolean;
 }
 
+/** Configuration of the states database connection */
 export interface StatesDatabaseOptions extends DatabaseOptions {
     /** Limit maximum number of log entries in the list (only read by adapter.ts from the config file) */
     maxQueue: number;
@@ -90,6 +108,7 @@ export interface StatesDatabaseOptions extends DatabaseOptions {
  * The ioBroker global config
  */
 export interface IoBJson {
+    /** System-wide controller settings */
     system: {
         /** Do not use more than memory limit mb by ioB process (0 to deactivate) */
         memoryLimitMB: number;
@@ -116,14 +135,18 @@ export interface IoBJson {
         memLimitError: number;
         '// memLimitError': string;
     };
+    /** Configuration of the multihost service used to connect several ioBroker hosts */
     multihostService: {
         enabled: boolean;
         secure: boolean;
         password: string;
         persist: boolean;
     };
+    /** Configuration of the objects database */
     objects: ObjectsDatabaseOptions;
+    /** Configuration of the states database */
     states: StatesDatabaseOptions;
+    /** Logging configuration */
     log: {
         level: ioBroker.LogLevel;
         maxDays: number;
@@ -132,13 +155,16 @@ export interface IoBJson {
     };
     /** Always relative to iobroker.js-controller/ */
     dataDir: string;
+    /** Comment/hint shown next to the dataDir setting in the JSON config */
     '// dataDir': string;
+    /** Controller plugins configuration keyed by plugin name */
     plugins: {
         [pluginName: string]: {
             enabled: boolean;
             [other: string]: unknown;
         };
     };
+    /** Comment/hint shown next to the dnsResolution setting in the JSON config */
     '// dnsResolution': string;
     /** Use 'verbatim' for ipv6 first, else use 'ipv4first' */
     dnsResolution: 'verbatim' | 'ipv4first';

package/build/objects.d.ts

@@ -735,7 +735,7 @@ declare global {
             /** Whether the admin tab is written in a materialized style. Required for Admin 3+ */
             materializeTab?: boolean;
             /** Whether the admin configuration dialog is written in a materialized style. Required for Admin 3+ */
-            /** @deprectaed Use adminUI with config = "materialize". But better use jsonConfig.json */
+            /** @deprecated Use adminUI with config = "materialize". But better use jsonConfig.json */
             materialize: boolean;
             /** @deprecated Use @see supportedMessages up from controller v5 */
             messagebox?: true;