@iobroker/types 5.0.13 → 5.0.14-alpha.0-20231017-1cfd77e8

package/build/types.d.ts

@@ -287,6 +287,11 @@ export declare interface AdapterClass {
  *
  */
 export declare class AdapterClass extends EventEmitter {
+    #private;
+    /** States DB constructor */
+    private States?;
+    /** Objects DB constructor */
+    private Objects?;
     /** Contents of iobroker.json */
     private readonly _config;
     private readonly _options;
@@ -778,7 +783,7 @@ export declare interface AdapterOptions {
     name: string;
     /** If true, the systemConfig (iobroker.json) will be available in this.systemConfig */
     systemConfig?: boolean;
-    /** callback function (id, obj) that will be called if object changed */
+    /** callback function (id, obj) that will be called if an object changed */
     objectChange?: ioBroker.ObjectChangeHandler;
     /** callback function (id, obj) that will be called if state changed */
     stateChange?: ioBroker.StateChangeHandler;
@@ -788,7 +793,7 @@ export declare interface AdapterOptions {
     uiClientSubscribe?: UserInterfaceClientSubscribeHandler;
     /** callback function that will be called when a new UI client unsubscribes */
     uiClientUnsubscribe?: UserInterfaceClientUnsubscribeHandler;
-    /** callback to inform about new message the adapter */
+    /** callback to inform about a new message the adapter */
     message?: ioBroker.MessageHandler;
     /** callback to stop the adapter */
     unload?: ioBroker.UnloadHandler;
@@ -1244,7 +1249,7 @@ declare enum STATE_QUALITY {
     BAD = 1,
     /** The instance cannot establish a connection */
     CONNECTION_PROBLEM = 2,
-    /** Substitute value from controller, do not set this in adapters */
+    /** Substitute value from controller. Do not set this in adapters */
     SUBSTITUTE_FROM_CONTROLLER = 16,
     /** Quality for default values */
     SUBSTITUTE_INITIAL_VALUE = 32,
@@ -1311,13 +1316,13 @@ export declare interface UserInterfaceSubscribeInfo {
 }
 
 export declare type UserInterfaceUnsubscribeInfo = UserInterfaceUnsubscribeInfoBaseObject & ({
-    /** Reason for unsubscribe */
+    /** Reason for unsubscribing */
     reason: Exclude<UserInterfaceClientUnsubscribeReason, ClientUnsubscribeReason>;
     message?: undefined;
 } | {
-    /** Reason for unsubscribe */
+    /** Reason for unsubscribing */
     reason: ClientUnsubscribeReason;
-    /** Message used for unsubscribe */
+    /** Message used for unsubscribing */
     message: ioBroker.Message;
 });
 
@@ -1327,7 +1332,7 @@ declare type UserInterfaceUnsubscribeInfoBaseObject = {
 };
 
 declare interface ValidateIdOptions {
-    /** in maintenance mode we can access ivnalid ids to delete them, only works with the admin user */
+    /** in maintenance mode, we can access invalid ids to delete them, only works with the admin user */
     maintenance?: boolean;
     user?: string;
 }
@@ -1346,12 +1351,12 @@ export declare class Validator {
      * @param namespaceLog - Log prefix
      * @param logger - Logger instance
      * @param namespace - the namespace of the adapter
-     * @param namespaceRegExp - the namespace RegExp of the adapter adapter.0
+     * @param namespaceRegExp - the namespace RegExp of the adapter `adapter.0`
      */
     constructor(objects: any, states: any, namespaceLog: string, logger: any, namespace: string, namespaceRegExp: RegExp);
     /**
      * Performs the strict object check, which includes checking object existence, read-only logic, type and min/max
-     * additionally it rounds state values whose objects have a common.step attribute defined
+     * additionally it rounds state values whose objects have a `common.step` attribute defined
      *
      * @param id - id of the state
      * @param state - ioBroker setState object
@@ -1374,55 +1379,55 @@ export declare class Validator {
      */
     static getErrorText(code: number): string;
     /**
-     * Throws if type is not matching the expected type
-     * @param value value to check type of
+     * Throws if a type is not matching the expected type
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertString(value: unknown, name: string): asserts value is string;
     /**
-     * Throws if type is not a pattern
-     * @param value value to check type of
+     * Throws if a type is not a pattern
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertPattern(value: unknown, name: string): asserts value is Pattern_2;
     /**
-     * Throws if type is not matching the expected type
-     * @param value value to check type of
+     * Throws if a type is not matching the expected type
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertBoolean(value: unknown, name: string): asserts value is boolean;
     /**
-     * Throws if type is not matching the expected type
-     * @param value value to check type of
+     * Throws if a type is not matching the expected type
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertNumber(value: unknown, name: string): asserts value is number;
     /**
-     * Throws if type is not matching the expected type
-     * @param value value to check type of
+     * Throws if a type is not matching the expected type
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertObject(value: unknown, name: string): asserts value is Record<string, any>;
     /**
-     * Throws if type is not an optional callback
-     * @param value value to check type of
+     * Throws if a type is not an optional callback
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertBuffer(value: unknown, name: string): asserts value is Buffer;
     /**
-     * Throws if type is not an optional callback
-     * @param value value to check type of
+     * Throws if a type is not an optional callback
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertOptionalCallback(value: unknown, name: string): asserts value is OptionalCallback;
     /**
-     * Throws if type is not an optional callback
-     * @param value value to check type of
+     * Throws if a type is not an optional callback
+     * @param value value to check a type of
      * @param name name of the parameter for logging
      */
     static assertCallback(value: unknown, name: string): asserts value is Callback;
     /**
-     * Adds the namespace to the id if it is missing, if an object is passed it will be converted to an id string
+     * Adds the namespace to the ID if it is missing, if an object is passed it will be converted to an id string
      *
      * @param id id which will be fixed
      * @param isPattern if the id is a pattern
@@ -1434,7 +1439,7 @@ export declare class Validator {
      */
     validateSetStateObjectArgument(obj: Record<string, any>): void;
     /**
-     * Validates, that the timeout is not exceeding a 32-bit signed integer
+     * Validates that the timeout is not exceeding a 32-bit signed integer
      *
      * @param ms milliseconds to validate
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/types",
-  "version": "5.0.13",
+  "version": "5.0.14-alpha.0-20231017-1cfd77e8",
   "engines": {
     "node": ">=12.0.0"
   },
@@ -41,5 +41,5 @@
       ]
     }
   },
-  "gitHead": "1d35bccc401b9219b444ca737cb827d57c7e666c"
+  "gitHead": "6310c435dc597062a1a146d55a70e960ec111509"
 }