@iobroker/db-objects-redis 7.2.2 → 7.2.3-alpha.1-20260621-61726ea22

package/build/cjs/lib/objects/objectsInRedisClient.d.ts

@@ -6,21 +6,37 @@ type GetUserGroupCallbackNoError = (user: string, groups: string[], acl: ioBroke
 interface RedisConnectionOptions extends ConnectionOptions {
     redisNamespace?: string;
 }
+/** Settings for the objects database client */
 export interface ObjectsSettings {
+    /** Called once the client is connected */
     connected: () => void;
+    /** Whether this client runs inside the controller */
     controller?: boolean;
+    /** Called when the connection to the primary host is lost */
     primaryHostLost?: () => void;
+    /** Called when the client gets disconnected */
     disconnected?: () => void;
+    /** Handler for system-level object changes */
     change?: ChangeFunction;
+    /** Handler for user-level object changes */
     changeUser?: ChangeFunction;
+    /** Handler for user-level file changes */
     changeFileUser?: ioBroker.FileChangeHandler;
+    /** Whether to connect to the database immediately (default true) */
     autoConnect?: boolean;
+    /** Logger instance to use */
     logger: InternalLogger;
+    /** Name of this host */
     hostname?: string;
+    /** Namespace of this client */
     namespace?: string;
+    /** Default ACL applied to newly created objects */
     defaultNewAcl?: ACLObject;
+    /** Namespace used for meta information */
     metaNamespace?: string;
+    /** Redis key prefix (defaults to "cfg") */
     redisNamespace?: string;
+    /** Connection options for the redis server */
     connection: RedisConnectionOptions;
 }
 interface CallOptions {
@@ -43,6 +59,9 @@ interface Options {
 type CheckFileCallback = (checkFailed: boolean, options?: CallOptions, fileOptions?: {
     notExists: boolean;
 }) => void;
+/**
+ * Client for the objects database backed by Redis (or the in-memory redis-protocol server)
+ */
 export declare class ObjectsInRedisClient {
     private client;
     private readonly fileNamespace;
@@ -69,12 +88,21 @@ export declare class ObjectsInRedisClient {
     private noLegacyMultihost?;
     private readonly userSubscriptions;
     private readonly systemSubscriptions;
+    /**
+     * @param settings Settings for the objects client including connection and namespaces
+     */
     constructor(settings: ObjectsSettings);
     /**
      * Checks if we are allowed to start and sets the protocol version accordingly
      */
     private _determineProtocolVersion;
+    /**
+     * Connect to the objects database and set up the change and file subscriptions
+     */
     connectDb(): void;
+    /**
+     * Get the current status of the database
+     */
     getStatus(): DbStatus;
     /**
      * Checks if given ID is a meta-object, else throws error
@@ -83,6 +111,11 @@ export declare class ObjectsInRedisClient {
      * @throws Error if id is invalid
      */
     validateMetaObject(id: string): Promise<void>;
+    /**
+     * Normalize a file name by collapsing slashes and backslashes into a single forward slash
+     *
+     * @param name The file name to normalize
+     */
     normalizeFilename(name: string): string;
     /**
      * Sets a buffer to the Redis DB
@@ -103,18 +136,94 @@ export declare class ObjectsInRedisClient {
      * @param id - id to delete, with namespace prefix
      */
     private _delBinaryState;
+    /**
+     * Build the internal redis key for a file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param isMeta Whether to return the key of the meta entry (true) or the data entry (false)
+     */
     getFileId(id: string, name: string, isMeta?: boolean): string;
+    /**
+     * Check whether the current options have the required rights on a file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the user
+     * @param flag The access flag(s) to check for
+     * @param callback Called with whether the check failed and the effective options
+     */
     checkFile(id: string, name: string, options: CallOptions, flag: any, callback?: CheckFileCallback): Promise<ioBroker.CallbackReturnTypeOf<CheckFileCallback> | void>;
+    /**
+     * Check whether the current user is allowed to access a file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name, or null for the whole namespace
+     * @param options The current request options including the user
+     * @param flag The access flag(s) to check for
+     * @param callback Called with the effective options once the rights have been checked
+     */
     checkFileRights(id: string, name: string | null, options?: CallOptions | null, flag?: any, callback?: CheckFileRightsCallback): void;
     private _setDefaultAcl;
+    /**
+     * Set the default ACL applied to new objects and apply it to all existing objects without an ACL
+     *
+     * @param defaultNewAcl The default ACL to use, or null to use the built-in default
+     */
     setDefaultAcl(defaultNewAcl: ACLObject | null): Promise<void>;
+    /**
+     * Determine the groups and effective ACL of the given user
+     *
+     * @param user The id of the user to look up
+     * @param callback Called with the user, its groups and the effective ACL
+     */
     getUserGroup(user: ioBroker.ObjectIDs.User, callback: GetUserGroupCallbackNoError): Promise<GetUserGroupPromiseReturn> | void;
     private _writeFile;
+    /**
+     * Write data into a file of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param data The data to write
+     * @param callback Called once the file has been written
+     */
     writeFile(id: string, name: string, data: any, callback?: ioBroker.ErrorCallback): Promise<void>;
+    /**
+     * Write data into a file of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param data The data to write
+     * @param options The current request options including the user
+     * @param callback Called once the file has been written
+     */
     writeFile(id: string, name: string, data: any, options?: WriteFileOptions | null, callback?: ioBroker.ErrorCallback): Promise<void>;
+    /**
+     * Promise-version of writeFile
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param data The data to write
+     * @param options The current request options including the user
+     */
     writeFileAsync(id: string, name: string, data: any, options?: WriteFileOptions | null): Promise<void>;
     private _readFile;
+    /**
+     * Read a file of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the user
+     */
     readFile(id: string, name: string, options?: CallOptions | null): ioBroker.ReadFilePromise;
+    /**
+     * Read a file of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the user
+     * @param callback Called with the file content and mime type
+     */
     readFile(id: string, name: string, options: CallOptions | null | undefined, callback: ioBroker.ReadFileCallback): void;
     /**
      * Check if given object exists
@@ -132,29 +241,151 @@ export declare class ObjectsInRedisClient {
      */
     fileExists(id: string, name: string, options?: CallOptions | null): Promise<boolean>;
     private _unlink;
+    /**
+     * Delete a file or directory of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file or directory name to delete
+     * @param options The current request options including the user, or the callback
+     * @param callback Called with the list of removed files
+     */
     unlink(id: string, name: string, options: CallOptions | null | undefined, callback?: ioBroker.RmCallback): void;
+    /**
+     * Promise-version of unlink
+     *
+     * @param id The id of the object owning the file
+     * @param name The file or directory name to delete
+     * @param options The current request options including the user
+     */
     unlinkAsync(id: string, name: string, options?: CallOptions): Promise<void>;
+    /**
+     * Delete a file of an object (alias for unlink)
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name to delete
+     * @param options The current request options including the user
+     * @param callback Called once the file has been deleted
+     */
     delFile(id: string, name: string, options: CallOptions, callback: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of delFile
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name to delete
+     * @param options The current request options including the user
+     */
     delFileAsync(id: string, name: string, options: CallOptions): Promise<void>;
     private _readDir;
+    /**
+     * List the contents of a directory of an object
+     *
+     * @param id The id of the object owning the files
+     * @param name The directory name to list
+     * @param options The current request options including the user, or the callback
+     * @param callback Called with the directory entries
+     */
     readDir(id: string, name: string, options: CallOptions | null | undefined, callback: ioBroker.ReadDirCallback): void;
+    /**
+     * Promise-version of readDir
+     *
+     * @param id The id of the object owning the files
+     * @param name The directory name to list
+     * @param options The current request options including the user
+     */
     readDirAsync(id: string, name: string, options?: CallOptions): ioBroker.ReadDirPromise;
     private _renameHelper;
     private _rename;
+    /**
+     * Rename a file or directory of an object
+     *
+     * @param id The id of the object owning the file
+     * @param oldName The current file or directory name
+     * @param newName The new file or directory name
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the file has been renamed
+     */
     rename(id: string, oldName: string, newName: string, options?: CallOptions | null, callback?: ioBroker.ErrorCallback): void | Promise<void>;
+    /**
+     * Promise-version of rename
+     *
+     * @param id The id of the object owning the file
+     * @param oldName The current file or directory name
+     * @param newName The new file or directory name
+     * @param options The current request options including the user
+     */
     renameAsync(id: string, oldName: string, newName: string, options: CallOptions): Promise<void>;
     private _touch;
+    /**
+     * Update the modification time of a file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the file has been touched
+     */
     touch(id: string, name: string, options: CallOptions | null, callback: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of touch
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the user
+     */
     touchAsync(id: string, name: string, options: CallOptions): Promise<void>;
     private _rmHelper;
     private _rm;
+    /**
+     * Delete a file or directory of an object
+     *
+     * @param id The id of the object owning the file
+     * @param name The file or directory name to delete
+     * @param options The current request options including the user, or the callback
+     * @param callback Called with the list of removed files
+     */
     rm(id: string, name: string, options: CallOptions | null, callback: ioBroker.RmCallback): void;
+    /**
+     * Promise-version of rm
+     *
+     * @param id The id of the object owning the file
+     * @param name The file or directory name to delete
+     * @param options The current request options including the user
+     */
     rmAsync(id: string, name: string, options: CallOptions): Promise<void | ioBroker.RmResult[]>;
+    /**
+     * Create a directory for an object's files (simulated, as redis has no real directories)
+     *
+     * @param id The id of the object owning the files
+     * @param dirName The directory name to create
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the directory has been created
+     */
     mkdir(id: string, dirName?: string, options?: CallOptions | null, callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of mkdir
+     *
+     * @param id The id of the object owning the files
+     * @param dirName The directory name to create
+     * @param options The current request options including the user
+     */
     mkdirAsync(id: string, dirName?: string, options?: CallOptions): Promise<void>;
     private _chownFileHelper;
     private _chownFile;
+    /**
+     * Change the owner and owner group of a file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the new owner and the user
+     * @param callback Called with the processed file(s)
+     */
     chownFile(id: string, name: string, options: CallOptions, callback: ioBroker.ChownFileCallback): void;
+    /**
+     * Promise-version of chownFile
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the new owner and the user
+     */
     chownFileAsync(id: string, name: string, options: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ChownFileCallback>>;
     /**
      *
@@ -165,78 +396,362 @@ export declare class ObjectsInRedisClient {
      */
     private _chmodFileHelper;
     private _chmodFile;
+    /**
+     * Change the file mode (permissions) of a single file
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the new mode and the user, or the callback
+     * @param callback Called with the processed file
+     */
     chmodFile(id: string, name: string, options: CallOptions | null, callback: ioBroker.ChownFileCallback): void;
+    /**
+     * Promise-version of chmodFile
+     *
+     * @param id The id of the object owning the file
+     * @param name The file name
+     * @param options The current request options including the new mode and the user
+     */
     chmodFileAsync(id: string, name: string, options: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ChownFileCallback>>;
+    /**
+     * Enable or disable the file cache
+     *
+     * @param enabled Whether the file cache should be enabled
+     * @param callback Called with the resulting cache state
+     */
     enableFileCache(enabled: boolean, callback?: (err: Error | null | undefined, res: boolean) => void): void;
+    /**
+     * Enable or disable the file cache
+     *
+     * @param enabled Whether the file cache should be enabled
+     * @param options The current request options including the user
+     * @param callback Called with the resulting cache state
+     */
     enableFileCache(enabled: boolean, options?: CallOptions, callback?: (err: Error | null | undefined, res: boolean) => void): void;
+    /**
+     * Promise-version of enableFileCache
+     *
+     * @param enabled Whether the file cache should be enabled
+     * @param options The current request options including the user
+     */
     enableFileCacheAsync(enabled: boolean, options?: CallOptions): Promise<boolean>;
     private _subscribeFile;
     private _unsubscribeFile;
+    /**
+     * Subscribe a user to file changes of an object
+     *
+     * @param id The id of the object owning the files
+     * @param pattern One or more file name patterns to subscribe to
+     * @param options The current request options including the user
+     */
     subscribeUserFile(id: string, pattern: string | string[], options?: CallOptions | null): Promise<void>;
+    /**
+     * Unsubscribe a user from file changes of an object
+     *
+     * @param id The id of the object owning the files
+     * @param pattern One or more file name patterns to unsubscribe from
+     * @param options The current request options including the user
+     */
     unsubscribeUserFile(id: string, pattern: string | string[], options?: CallOptions | null): Promise<void>;
     private _subscribe;
     private subscribeConfig;
+    /**
+     * Subscribe to object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param callback Called once the subscription is registered
+     */
     subscribe(pattern: string | string[], callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Subscribe to object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     * @param callback Called once the subscription is registered
+     */
     subscribe(pattern: string | string[], options?: CallOptions, callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of subscribe
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     */
     subscribeAsync(pattern: string | string[], options?: CallOptions): Promise<void>;
+    /**
+     * Subscribe a user to object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param callback Called once the subscription is registered
+     */
     subscribeUser(pattern: string | string[], callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Subscribe a user to object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     * @param callback Called once the subscription is registered
+     */
     subscribeUser(pattern: string | string[], options?: CallOptions | null, callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of subscribeUser
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     */
     subscribeUserAsync(pattern: string | string[], options: CallOptions): Promise<void>;
     private _unsubscribe;
     private unsubscribeConfig;
+    /**
+     * Unsubscribe from object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param callback Called once the subscription is removed
+     */
     unsubscribe(pattern: string | string[], callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Unsubscribe from object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user
+     * @param callback Called once the subscription is removed
+     */
     unsubscribe(pattern: string | string[], options?: CallOptions | null, callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of unsubscribe
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user
+     */
     unsubscribeAsync(pattern: string | string[], options: CallOptions): Promise<void>;
+    /**
+     * Unsubscribe a user from object changes matching the given pattern
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the subscription is removed
+     */
     unsubscribeUser(pattern: string | string[], options?: CallOptions | null, callback?: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of unsubscribeUser
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user
+     */
     unsubscribeUserAsync(pattern: string | string[], options: CallOptions): Promise<void>;
     private _objectHelper;
     private _chownObject;
+    /**
+     * Change the owner and owner group of all objects matching the given pattern
+     *
+     * @param pattern The pattern of object ids whose owner should be changed
+     * @param options The current request options including the new owner and the user, or the callback
+     * @param callback Called with the list of changed objects
+     */
     chownObject(pattern: string, options: CallOptions, callback?: ioBroker.ChownObjectCallback): void | Promise<void>;
+    /**
+     * Promise-version of chownObject
+     *
+     * @param pattern The pattern of object ids whose owner should be changed
+     * @param options The current request options including the new owner and the user
+     */
     chownObjectAsync(pattern: string, options: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ChownObjectCallback>>;
     private _chmodObject;
+    /**
+     * Change the file mode (permissions) of all files matching the given pattern
+     *
+     * @param pattern The pattern of object ids whose files should be changed
+     * @param options The current request options including the new mode and the user, or the callback
+     * @param callback Called with the list of changed objects
+     */
     chmodObject(pattern: string, options: CallOptions | null, callback?: ioBroker.ChownObjectCallback): void | Promise<void>;
+    /**
+     * Promise-version of chmodObject
+     *
+     * @param pattern The pattern of object ids whose files should be changed
+     * @param options The current request options including the new mode and the user
+     */
     chmodObjectAsync(pattern: string, options: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ChownObjectCallback>>;
     private _getObject;
+    /**
+     * Get a single object by its id
+     *
+     * @param id The id of the object to read
+     * @param options The current request options including the user
+     * @param callback Called with the read object
+     */
     getObject<T extends string>(id: T, options: Options | undefined | null, callback: ioBroker.GetObjectCallback<T>): void;
+    /**
+     * Get a single object by its id
+     *
+     * @param id The id of the object to read
+     * @param options The current request options including the user
+     */
     getObject<T extends string>(id: T, options?: Options | null): ioBroker.GetObjectPromise<T>;
+    /**
+     * Get a single object by its id
+     *
+     * @param id The id of the object to read
+     * @param callback Called with the read object
+     */
     getObject<T extends string>(id: T, callback: ioBroker.GetObjectCallback<T>): void;
     /**
+     * Promise-version of getObject
      *
-     * @param id
-     * @param options
+     * @param id The id of the object to read
+     * @param options The current request options including the user
      * @deprecated use `getObject` without callback instead
      */
     getObjectAsync<T extends string>(id: T, options?: Record<string, any> | null): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.GetObjectCallback<T>>>;
     private _getKeys;
+    /**
+     * Get all object ids matching the given pattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     * @param callback Called with the matching keys
+     * @param dontModify If true, the returned keys are not stripped of the namespace
+     */
     getKeys(pattern: string, options: CallOptions | null | undefined, callback: ioBroker.GetKeysCallback, dontModify?: boolean): void;
+    /**
+     * Get all object ids matching the given pattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param callback Called with the matching keys
+     */
     getKeys(pattern: string, callback: ioBroker.GetKeysCallback): void;
+    /**
+     * Get all object ids matching the given pattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     * @param callback Must be undefined for the promise variant
+     * @param dontModify If true, the returned keys are not stripped of the namespace
+     */
     getKeys(pattern: string, options?: CallOptions | null, callback?: undefined, dontModify?: boolean): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.GetKeysCallback>>;
-    getKeysAsync(id: string, options?: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.GetKeysCallback>>;
+    /**
+     * Promise-version of getKeys
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     */
+    getKeysAsync(pattern: string, options?: CallOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.GetKeysCallback>>;
     private _getObjects;
+    /**
+     * Get multiple objects by their ids
+     *
+     * @param keys The ids of the objects to read
+     * @param options The current request options including the user
+     */
     getObjects(keys: string[], options?: CallOptions | null): Promise<ioBroker.AnyObject[]>;
+    /**
+     * Get multiple objects by their ids
+     *
+     * @param keys The ids of the objects to read
+     * @param callback Called with the read objects
+     */
     getObjects(keys: string[], callback: (err?: Error | null, objs?: ioBroker.AnyObject[]) => void): void;
+    /**
+     * Get multiple objects by their ids
+     *
+     * @param keys The ids of the objects to read
+     * @param options The current request options including the user
+     * @param callback Called with the read objects
+     * @param dontModify If true, the returned objects are not cloned/modified
+     */
     getObjects(keys: string[], options: CallOptions | null, callback: (err?: Error | null, objs?: ioBroker.AnyObject[]) => void, dontModify?: boolean): void;
+    /**
+     * Promise-version of getObjects
+     *
+     * @param keys The ids of the objects to read
+     * @param options The current request options including the user
+     */
     getObjectsAsync(keys: string[], options?: CallOptions | null): Promise<ioBroker.AnyObject[]>;
     private _getObjectsByPattern;
+    /**
+     * Get all objects whose id matches the given pattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     */
     getObjectsByPattern(pattern: string, options: CallOptions | null): Promise<ioBroker.AnyObject[] | void>;
+    /**
+     * Get all objects whose id matches the given pattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     * @param callback Called with the matching objects
+     */
     getObjectsByPattern(pattern: string, options: CallOptions | null, callback: (err?: Error | null, objs?: ioBroker.AnyObject[]) => void): void;
+    /**
+     * Promise-version of getObjectsByPattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     */
     getObjectsByPatternAsync(pattern: string, options: CallOptions): Promise<ioBroker.AnyObject[] | void>;
     private _setObject;
+    /**
+     * Set anew or update an object
+     *
+     * @param id ID of the object
+     * @param obj The object to write
+     */
     setObject<T extends string>(id: T, obj: ioBroker.SettableObject<ioBroker.ObjectIdToObjectType<T>>): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.SetObjectCallback>>;
+    /**
+     * Set anew or update an object
+     *
+     * @param id ID of the object
+     * @param obj The object to write
+     * @param callback return function
+     */
     setObject<T extends string>(id: T, obj: ioBroker.SettableObject<ioBroker.ObjectIdToObjectType<T>>, callback?: ioBroker.SetObjectCallback): void | Promise<ioBroker.CallbackReturnTypeOf<ioBroker.SetObjectCallback>>;
+    /**
+     * Set anew or update an object
+     *
+     * @param id ID of the object
+     * @param obj The object to write
+     * @param options options for access control are optional
+     * @param callback return function
+     */
     setObject<T extends string>(id: T, obj: ioBroker.SettableObject<ioBroker.ObjectIdToObjectType<T>>, options?: CallOptions | null, callback?: ioBroker.SetObjectCallback): void | Promise<ioBroker.CallbackReturnTypeOf<ioBroker.SetObjectCallback>>;
     /**
+     * Promise-version of setObject
      *
-     * @param id
-     * @param obj
-     * @param options
+     * @param id ID of the object
+     * @param obj The object to write
+     * @param options options for access control are optional
      * @deprecated use `setObject` without callback instead
      */
     setObjectAsync(id: string, obj: ioBroker.SettableObject, options?: CallOptions | null): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.SetObjectCallback>>;
     private _delObject;
+    /**
+     * Delete an object
+     *
+     * @param id The id of the object to delete
+     * @param callback Called once the object has been deleted
+     */
     delObject(id: string, callback: ioBroker.ErrorCallback): void;
+    /**
+     * Delete an object
+     *
+     * @param id The id of the object to delete
+     * @param options The current request options including the user
+     * @param callback Called once the object has been deleted
+     */
     delObject(id: string, options: CallOptions | null, callback: ioBroker.ErrorCallback): void;
+    /**
+     * Delete an object
+     *
+     * @param id The id of the object to delete
+     * @param options The current request options including the user
+     */
     delObject(id: string, options?: CallOptions | null): Promise<void>;
+    /**
+     * Promise-version of delObject
+     *
+     * @param id The id of the object to delete
+     * @param options The current request options including the user
+     */
     delObjectAsync(id: string, options?: CallOptions): Promise<void>;
     /**
      * Function to checks if comparisons will work according to the configured Locale
@@ -244,42 +759,171 @@ export declare class ObjectsInRedisClient {
     isSystemLocaleSupported(): Promise<boolean>;
     private _applyViewFunc;
     private _getObjectView;
+    /**
+     * Run a predefined object view (design document) and return the matching rows
+     *
+     * @param design The design document name
+     * @param search The view name within the design document
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     */
     getObjectView<Design extends string = string, Search extends string = string>(design: Design, search: Search, params?: ioBroker.GetObjectViewParams, options?: CallOptions | null): ioBroker.GetObjectViewPromise<ioBroker.InferGetObjectViewItemType<Design, Search>>;
+    /**
+     * Run a predefined object view (design document) and return the matching rows
+     *
+     * @param design The design document name
+     * @param search The view name within the design document
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     * @param callback Called with the matching rows
+     */
     getObjectView<Design extends string = string, Search extends string = string>(design: Design, search: Search, params: ioBroker.GetObjectViewParams | undefined, options: CallOptions | undefined | null, callback: ioBroker.GetObjectViewCallback<ioBroker.InferGetObjectViewItemType<Design, Search>>): void;
+    /**
+     * Run a predefined object view (design document) and return the matching rows
+     *
+     * @param design The design document name
+     * @param search The view name within the design document
+     * @param params Query parameters such as startkey and endkey
+     * @param callback Called with the matching rows
+     */
     getObjectView<Design extends string = string, Search extends string = string>(design: Design, search: Search, params: ioBroker.GetObjectViewParams, callback: ioBroker.GetObjectViewCallback<ioBroker.InferGetObjectViewItemType<Design, Search>>): void;
+    /**
+     * Promise-version of getObjectView
+     *
+     * @param design The design document name
+     * @param search The view name within the design document
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     */
     getObjectViewAsync<Design extends string = string, Search extends string = string>(design: Design, search: Search, params?: ioBroker.GetObjectViewParams, options?: CallOptions): ioBroker.GetObjectViewPromise<ioBroker.InferGetObjectViewItemType<Design, Search>>;
     private _getObjectList;
+    /**
+     * Get the list of objects matching the given parameters
+     *
+     * @param params Query parameters such as startkey and endkey
+     */
     getObjectList(params: ioBroker.GetObjectListParams): ioBroker.GetObjectListPromise;
+    /**
+     * Get the list of objects matching the given parameters
+     *
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     */
     getObjectList(params: ioBroker.GetObjectListParams, options?: CallOptions | null): ioBroker.GetObjectListPromise;
+    /**
+     * Get the list of objects matching the given parameters
+     *
+     * @param params Query parameters such as startkey and endkey
+     * @param callback Called with the matching objects
+     */
     getObjectList(params: ioBroker.GetObjectListParams, callback: ioBroker.GetObjectListCallback<ioBroker.Object>): void;
+    /**
+     * Get the list of objects matching the given parameters
+     *
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     * @param callback Called with the matching objects
+     */
     getObjectList<T extends ioBroker.GetObjectListCallback<ioBroker.Object>>(params: ioBroker.GetObjectListParams, options?: CallOptions | null, callback?: T): T extends ioBroker.GetObjectListCallback<ioBroker.Object> ? void : ioBroker.GetObjectListPromise;
+    /**
+     * Promise-version of getObjectList
+     *
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     */
     getObjectListAsync(params: ioBroker.GetObjectListParams, options?: CallOptions): ioBroker.GetObjectListPromise;
     private _extendObject;
+    /**
+     * Extend an existing object with the given partial object, creating it if it does not exist
+     *
+     * @param id The id of the object to extend
+     * @param obj The partial object to merge into the existing object
+     * @param options The current request options including the user
+     */
     extendObject<T extends string>(id: T, obj: ioBroker.PartialObject<ioBroker.ObjectIdToObjectType<T, 'write'>>, options?: ioBroker.ExtendObjectOptions | null): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ExtendObjectCallback>>;
+    /**
+     * Extend an existing object with the given partial object, creating it if it does not exist
+     *
+     * @param id The id of the object to extend
+     * @param obj The partial object to merge into the existing object
+     * @param options The current request options including the user
+     * @param callback Called with the resulting object and its id
+     */
     extendObject<T extends string>(id: T, obj: ioBroker.PartialObject<ioBroker.ObjectIdToObjectType<T, 'write'>>, options?: ioBroker.ExtendObjectOptions | null, callback?: ioBroker.ExtendObjectCallback): void | Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ExtendObjectCallback>>;
+    /**
+     * Promise-version of extendObject
+     *
+     * @param id The id of the object to extend
+     * @param obj The partial object to merge into the existing object
+     * @param options The current request options including the user
+     */
     extendObjectAsync(id: string, obj: Partial<ioBroker.AnyObject>, options?: ioBroker.ExtendObjectOptions): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.ExtendObjectCallback>>;
     /**
      * Returns the object id if found
      *
-     * @param idOrName
-     * @param type
-     * @param options
-     * @param callback
+     * @param idOrName The id or name to search for
+     * @param type The expected common type, or null for any
+     * @param options The current request options (may include a language)
+     * @param callback Called with the found id and the original id/name
      */
     private _findObject;
+    /**
+     * Find an object by its id or name
+     *
+     * @param idOrName The id or name to search for
+     * @param type The expected common type, or null for any
+     * @param options The current request options (may include a language)
+     * @param callback Called with the found id and the original id/name
+     */
     findObject(idOrName: string, type: ioBroker.CommonType | null, options: (CallOptions & {
         language?: ioBroker.Languages;
     }) | null, callback: ioBroker.FindObjectCallback): void;
+    /**
+     * Find an object by its id or name
+     *
+     * @param idOrName The id or name to search for
+     * @param type The expected common type, or null for any
+     * @param callback Called with the found id and the original id/name
+     */
     findObject(idOrName: string, type: ioBroker.CommonType | null, callback: ioBroker.FindObjectCallback): void;
+    /**
+     * Find an object by its id or name
+     *
+     * @param idOrName The id or name to search for
+     * @param type The expected common type, or null for any
+     * @param options The current request options (may include a language)
+     */
     findObject(idOrName: string, type?: ioBroker.CommonType | null, options?: (CallOptions & {
         language?: ioBroker.Languages;
     }) | null): Promise<ioBroker.CallbackReturnTypeOf<ioBroker.FindObjectCallback>>;
+    /**
+     * Add object property paths that should be preserved when an object is overwritten (controller only)
+     *
+     * @param settings One or more property paths to preserve
+     */
     addPreserveSettings(settings: string[] | string): void;
     private _destroyDBHelper;
     private _destroyDB;
+    /**
+     * Delete the whole objects database (requires admin rights)
+     *
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the database has been destroyed
+     */
     destroyDB(options: CallOptions | null | undefined, callback: ioBroker.ErrorCallback): void;
+    /**
+     * Promise-version of destroyDB
+     *
+     * @param options The current request options including the user
+     */
     destroyDBAsync(options?: CallOptions): Promise<void>;
+    /**
+     * Destructor of the class. Called when shutting down to close the redis connections.
+     */
     destroy(): Promise<void>;
+    /**
+     * Load and register the Lua scripts used for atomic operations on the redis server
+     */
     loadLuaScripts(): Promise<void>;
     /**
      * Get all keys matching a pattern using redis SCAN command, duplicates are filtered out