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

package/build/esm/lib/objects/objectsInRedisClient.js

@@ -21,6 +21,9 @@ import * as url from 'node:url';
 // eslint-disable-next-line unicorn/prefer-module
 const thisDir = url.fileURLToPath(new URL('.', import.meta.url || `file://${__filename}`));
 const ERRORS = CONSTS.ERRORS;
+/**
+ * Client for the objects database backed by Redis (or the in-memory redis-protocol server)
+ */
 export class ObjectsInRedisClient {
     client;
     fileNamespace;
@@ -47,6 +50,9 @@ export class ObjectsInRedisClient {
     noLegacyMultihost;
     userSubscriptions;
     systemSubscriptions;
+    /**
+     * @param settings Settings for the objects client including connection and namespaces
+     */
     constructor(settings) {
         this.settings = settings || {};
         this.redisNamespace = `${this.settings.redisNamespace || this.settings.connection?.redisNamespace || 'cfg'}.`;
@@ -107,6 +113,9 @@ export class ObjectsInRedisClient {
             throw new Error(`This host does not support protocol version "${protoVersion}"`);
         }
     }
+    /**
+     * Connect to the objects database and set up the change and file subscriptions
+     */
     connectDb() {
         this.settings.connection = this.settings.connection || {};
         const onChange = this.settings.change; // on change handler
@@ -590,6 +599,9 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * Get the current status of the database
+     */
     getStatus() {
         return { type: 'redis', server: false };
     }
@@ -615,6 +627,11 @@ export class ObjectsInRedisClient {
             throw new Error(`${id} is not an object of type "meta"`);
         }
     }
+    /**
+     * Normalize a file name by collapsing slashes and backslashes into a single forward slash
+     *
+     * @param name The file name to normalize
+     */
     normalizeFilename(name) {
         return name ? name.replace(/[/\\]+/g, '/') : name;
     }
@@ -660,6 +677,13 @@ export class ObjectsInRedisClient {
             await this.client.publish(id, 'null'); // inform about deletion
         }
     }
+    /**
+     * 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, name, isMeta) {
         name = this.normalizeFilename(name);
         // e.g. ekey.admin and admin/ekey.png
@@ -686,6 +710,15 @@ export class ObjectsInRedisClient {
         name = normalized.name;
         return `${this.fileNamespace + id}$%$${name}${isMeta !== undefined ? (isMeta ? '$%$meta' : '$%$data') : ''}`;
     }
+    /**
+     * 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
+     */
     async checkFile(id, name, options, flag, callback) {
         // read file settings from redis
         const fileId = this.getFileId(id, name, true);
@@ -720,6 +753,15 @@ export class ObjectsInRedisClient {
         }
         return tools.maybeCallback(callback, true, options); // error
     }
+    /**
+     * 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, name, options, flag, callback) {
         return utils.checkFileRights(this, id, name, options, flag, callback);
     }
@@ -737,6 +779,11 @@ export class ObjectsInRedisClient {
             }
         }
     }
+    /**
+     * 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
+     */
     async setDefaultAcl(defaultNewAcl) {
         this.defaultNewAcl = defaultNewAcl || {
             owner: CONSTS.SYSTEM_ADMIN_USER,
@@ -756,6 +803,12 @@ export class ObjectsInRedisClient {
             this.log.error(`${this.namespace} Could not update default acl: ${e.message}`);
         }
     }
+    /**
+     * 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, callback) {
         return utils.getUserGroup(this, user, (error, user, userGroups, userAcl) => {
             if (error) {
@@ -823,6 +876,15 @@ export class ObjectsInRedisClient {
             }
         }
     }
+    /**
+     * 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, or the callback
+     * @param callback Called once the file has been written
+     */
     async writeFile(id, name, data, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -861,6 +923,14 @@ export class ObjectsInRedisClient {
             return this._writeFile(id, name, data, options, callback, meta);
         });
     }
+    /**
+     * 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, name, data, options) {
         return new Promise((resolve, reject) => this.writeFile(id, name, data, options, err => (err ? reject(err) : resolve())));
     }
@@ -879,6 +949,14 @@ export class ObjectsInRedisClient {
         }
         return { file: buffer, mimeType: mimeType };
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the file content and mime type
+     */
     readFile(id, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -991,6 +1069,14 @@ export class ObjectsInRedisClient {
         await this._delBinaryState(dataID);
         await this.client.del(metaID);
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1021,12 +1107,34 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.unlink(id, name, options, err => (err ? reject(err) : resolve())));
     }
+    /**
+     * 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, name, options, callback) {
         return this.unlink(id, name, options, callback);
     }
+    /**
+     * 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, name, options) {
         return this.unlinkAsync(id, name, options);
     }
@@ -1174,6 +1282,14 @@ export class ObjectsInRedisClient {
         }
         return tools.maybeCallbackWithError(callback, null, result);
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1202,6 +1318,13 @@ export class ObjectsInRedisClient {
             this._readDir(id, name, options, callback);
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.readDir(id, name, options, (err, res) => (err ? reject(err) : resolve(res))));
     }
@@ -1318,6 +1441,15 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithRedisError(callback, e);
         }
     }
+    /**
+     * 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, oldName, newName, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1358,6 +1490,14 @@ export class ObjectsInRedisClient {
             this._rename(id, oldName, newName, options, callback, meta);
         });
     }
+    /**
+     * 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, oldName, newName, options) {
         return new Promise((resolve, reject) => this.rename(id, oldName, newName, options, err => (err ? reject(err) : resolve())));
     }
@@ -1378,6 +1518,14 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithRedisError(callback, e);
         }
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1399,6 +1547,13 @@ export class ObjectsInRedisClient {
             return this._touch(id, name, callback, meta);
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.touch(id, name, options, err => (err ? reject(err) : resolve())));
     }
@@ -1494,6 +1649,14 @@ export class ObjectsInRedisClient {
             return files;
         }
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1521,10 +1684,25 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.rm(id, name, options, (err, files) => (err ? reject(err) : resolve(files))));
     }
     // simulate. redis has no dirs
+    /**
+     * 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, dirName, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1550,6 +1728,13 @@ export class ObjectsInRedisClient {
             this.writeFile(id, `${realName}_data.json`, '', options, callback);
         });
     }
+    /**
+     * 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, dirName, options) {
         return new Promise((resolve, reject) => this.mkdir(id, dirName, options, err => (err ? reject(err) : resolve())));
     }
@@ -1679,6 +1864,14 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithError(callback, err, processed);
         });
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1725,6 +1918,13 @@ export class ObjectsInRedisClient {
             return this._chownFile(id, name, options, callback, meta);
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.chownFile(id, name, options, (err, processed) => (err ? reject(err) : resolve(processed))));
     }
@@ -1858,6 +2058,14 @@ export class ObjectsInRedisClient {
         }
         this._chmodFileHelper(keysFiltered, objsFiltered, options, err => tools.maybeCallbackWithError(callback, err, processed));
     }
+    /**
+     * 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, name, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1890,9 +2098,23 @@ export class ObjectsInRedisClient {
             return this._chmodFile(id, name, options, callback, meta);
         });
     }
+    /**
+     * 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, name, options) {
         return new Promise((resolve, reject) => this.chmodFile(id, name, options, (err, processed) => (err ? reject(err) : resolve(processed))));
     }
+    /**
+     * Enable or disable the file cache
+     *
+     * @param enabled Whether the file cache should be enabled
+     * @param options The current request options including the user, or the callback
+     * @param callback Called with the resulting cache state
+     */
     enableFileCache(enabled, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -1909,6 +2131,12 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithError(callback, null, false);
         });
     }
+    /**
+     * Promise-version of enableFileCache
+     *
+     * @param enabled Whether the file cache should be enabled
+     * @param options The current request options including the user
+     */
     enableFileCacheAsync(enabled, options) {
         return new Promise((resolve, reject) => this.enableFileCache(enabled, options, (err, res) => (err ? reject(err) : resolve(res))));
     }
@@ -1958,6 +2186,13 @@ export class ObjectsInRedisClient {
             }
         }
     }
+    /**
+     * 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, pattern, options) {
         return new Promise((resolve, reject) => {
             utils.checkObjectRights(this, null, null, options, 'list', err => {
@@ -1972,6 +2207,13 @@ export class ObjectsInRedisClient {
             });
         });
     }
+    /**
+     * 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, pattern, options) {
         return new Promise((resolve, reject) => {
             utils.checkObjectRights(this, null, null, options, 'list', err => {
@@ -2025,6 +2267,13 @@ export class ObjectsInRedisClient {
             return this._subscribe(pattern, false, callback);
         });
     }
+    /**
+     * 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, or the callback
+     * @param callback Called once the subscription is registered
+     */
     subscribe(pattern, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2032,9 +2281,22 @@ export class ObjectsInRedisClient {
         }
         return this.subscribeConfig(pattern, options, callback);
     }
+    /**
+     * Promise-version of subscribe
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     */
     subscribeAsync(pattern, options) {
         return new Promise((resolve, reject) => this.subscribe(pattern, options, err => (err ? reject(err) : resolve())));
     }
+    /**
+     * 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, or the callback
+     * @param callback Called once the subscription is registered
+     */
     subscribeUser(pattern, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2047,6 +2309,12 @@ export class ObjectsInRedisClient {
             return this._subscribe(pattern, true, callback);
         });
     }
+    /**
+     * Promise-version of subscribeUser
+     *
+     * @param pattern One or more patterns to subscribe to
+     * @param options The current request options including the user
+     */
     subscribeUserAsync(pattern, options) {
         return new Promise((resolve, reject) => this.subscribeUser(pattern, options, err => (err ? reject(err) : resolve())));
     }
@@ -2088,6 +2356,13 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * 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, or the callback
+     * @param callback Called once the subscription is removed
+     */
     unsubscribe(pattern, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2095,9 +2370,22 @@ export class ObjectsInRedisClient {
         }
         return this.unsubscribeConfig(pattern, options, callback);
     }
+    /**
+     * Promise-version of unsubscribe
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user
+     */
     unsubscribeAsync(pattern, options) {
         return new Promise((resolve, reject) => this.unsubscribe(pattern, options, err => (err ? reject(err) : resolve())));
     }
+    /**
+     * 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, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2116,6 +2404,12 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * Promise-version of unsubscribeUser
+     *
+     * @param pattern One or more patterns to unsubscribe from
+     * @param options The current request options including the user
+     */
     unsubscribeUserAsync(pattern, options) {
         return new Promise((resolve, reject) => this.unsubscribeUser(pattern, options, err => (err ? reject(err) : resolve())));
     }
@@ -2214,6 +2508,13 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithError(callback, null, filteredObjs);
         }, true);
     }
+    /**
+     * 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, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2255,6 +2556,12 @@ export class ObjectsInRedisClient {
             return this._chownObject(pattern, options, callback);
         });
     }
+    /**
+     * 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, options) {
         return new Promise((resolve, reject) => this.chownObject(pattern, options, (err, list) => (err ? reject(err) : resolve(list))));
     }
@@ -2321,6 +2628,13 @@ export class ObjectsInRedisClient {
             }
         }, true);
     }
+    /**
+     * 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, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2351,6 +2665,12 @@ export class ObjectsInRedisClient {
             return this._chmodObject(pattern, options, callback);
         });
     }
+    /**
+     * 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, options) {
         return new Promise((resolve, reject) => this.chmodObject(pattern, options, (err, list) => (err ? reject(err) : resolve(list))));
     }
@@ -2388,6 +2708,13 @@ export class ObjectsInRedisClient {
         }
         return tools.maybeCallbackWithRedisError(callback, err, obj);
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the read object
+     */
     getObject(id, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2409,9 +2736,10 @@ export class ObjectsInRedisClient {
         }
     }
     /**
+     * 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(id, options) {
@@ -2488,6 +2816,14 @@ export class ObjectsInRedisClient {
         }
         return tools.maybeCallbackWithError(callback, null, result);
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the matching keys
+     * @param dontModify If true, the returned keys are not stripped of the namespace
+     */
     getKeys(pattern, options, callback, dontModify) {
         if (typeof options === 'function') {
             callback = options;
@@ -2505,8 +2841,14 @@ export class ObjectsInRedisClient {
             });
         }
     }
-    getKeysAsync(id, options) {
-        return this.getKeys(id, options);
+    /**
+     * Promise-version of getKeys
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     */
+    getKeysAsync(pattern, options) {
+        return this.getKeys(pattern, options);
     }
     async _getObjects(keys, options, callback, dontModify) {
         if (!keys) {
@@ -2579,6 +2921,14 @@ export class ObjectsInRedisClient {
         }
         return tools.maybeCallbackWithError(callback, null, result);
     }
+    /**
+     * Get multiple objects by their ids
+     *
+     * @param keys The ids of the objects to read
+     * @param options The current request options including the user, or the callback
+     * @param callback Called with the read objects
+     * @param dontModify If true, the returned objects are not cloned/modified
+     */
     getObjects(keys, options, callback, dontModify) {
         if (typeof options === 'function') {
             callback = options;
@@ -2601,6 +2951,12 @@ export class ObjectsInRedisClient {
             });
         }
     }
+    /**
+     * Promise-version of getObjects
+     *
+     * @param keys The ids of the objects to read
+     * @param options The current request options including the user
+     */
     getObjectsAsync(keys, options) {
         return this.getObjects(keys, options);
     }
@@ -2626,6 +2982,13 @@ export class ObjectsInRedisClient {
         }
         this._getObjects(keys, options, callback, true);
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the matching objects
+     */
     getObjectsByPattern(pattern, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2646,6 +3009,12 @@ export class ObjectsInRedisClient {
             });
         }
     }
+    /**
+     * Promise-version of getObjectsByPattern
+     *
+     * @param pattern The pattern to match object ids against
+     * @param options The current request options including the user
+     */
     getObjectsByPatternAsync(pattern, options) {
         return new Promise((resolve, reject) => this.getObjectsByPattern(pattern, options, (err, objs) => (err ? reject(err) : resolve(objs))));
     }
@@ -2833,7 +3202,7 @@ export class ObjectsInRedisClient {
      * This function writes the object into DB
      *
      * @param id ID of the object
-     * @param obj
+     * @param obj The object to write
      * @param options options for access control are optional
      * @param callback return function
      */
@@ -2863,10 +3232,11 @@ export class ObjectsInRedisClient {
         });
     }
     /**
+     * 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, obj, options) {
@@ -2935,6 +3305,13 @@ export class ObjectsInRedisClient {
             await this.client.publish(this.objNamespace + id, 'null');
         }
     }
+    /**
+     * Delete an object
+     *
+     * @param id The id of the object to delete
+     * @param options The current request options including the user, or the callback
+     * @param callback Called once the object has been deleted
+     */
     delObject(id, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -2959,6 +3336,12 @@ export class ObjectsInRedisClient {
             }
         });
     }
+    /**
+     * Promise-version of delObject
+     *
+     * @param id The id of the object to delete
+     * @param options The current request options including the user
+     */
     delObjectAsync(id, options) {
         return this.delObject(id, options);
     }
@@ -3454,6 +3837,15 @@ export class ObjectsInRedisClient {
             throw new Error(`Cannot find view "${design}"`);
         }
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the matching rows
+     */
     getObjectView(design, search, params, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -3480,6 +3872,14 @@ export class ObjectsInRedisClient {
             });
         }
     }
+    /**
+     * 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, search, params, options) {
         return this.getObjectView(design, search, params, options);
     }
@@ -3547,6 +3947,13 @@ export class ObjectsInRedisClient {
         }
         return result;
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the matching objects
+     */
     getObjectList(params, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -3573,6 +3980,12 @@ export class ObjectsInRedisClient {
             });
         }
     }
+    /**
+     * Promise-version of getObjectList
+     *
+     * @param params Query parameters such as startkey and endkey
+     * @param options The current request options including the user
+     */
     getObjectListAsync(params, options) {
         return this.getObjectList(params, options);
     }
@@ -3715,6 +4128,14 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithRedisError(callback, e);
         }
     }
+    /**
+     * 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, or the callback
+     * @param callback Called with the resulting object and its id
+     */
     extendObject(id, obj, options, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -3734,16 +4155,23 @@ export class ObjectsInRedisClient {
             return this._extendObject(id, obj, options, callback);
         });
     }
+    /**
+     * 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, obj, options) {
         return new Promise((resolve, reject) => this.extendObject(id, obj, options || null, (err, res) => (err ? reject(err) : resolve(res))));
     }
     /**
      * 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
      */
     _findObject(idOrName, type, options, callback) {
         // Try to read by ID
@@ -3793,6 +4221,14 @@ export class ObjectsInRedisClient {
             }, true);
         });
     }
+    /**
+     * 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), or the callback
+     * @param callback Called with the found id and the original id/name
+     */
     findObject(idOrName, type, options, callback) {
         if (typeof type === 'function') {
             callback = type;
@@ -3819,6 +4255,11 @@ export class ObjectsInRedisClient {
         }
     }
     // can be called only from js-controller
+    /**
+     * 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) {
         if (!Array.isArray(settings)) {
             settings = [settings];
@@ -3860,6 +4301,12 @@ export class ObjectsInRedisClient {
             return tools.maybeCallbackWithRedisError(callback, e);
         }
     }
+    /**
+     * 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, callback) {
         if (typeof options === 'function') {
             callback = options;
@@ -3876,10 +4323,17 @@ export class ObjectsInRedisClient {
             return this._destroyDB(callback);
         });
     }
+    /**
+     * Promise-version of destroyDB
+     *
+     * @param options The current request options including the user
+     */
     destroyDBAsync(options) {
         return new Promise((resolve, reject) => this.destroyDB(options, err => (err ? reject(err) : resolve())));
     }
-    // Destructor of the class. Called by shutting down.
+    /**
+     * Destructor of the class. Called when shutting down to close the redis connections.
+     */
     async destroy() {
         this.stop = true;
         if (this.client) {
@@ -3913,6 +4367,9 @@ export class ObjectsInRedisClient {
             }
         }
     }
+    /**
+     * Load and register the Lua scripts used for atomic operations on the redis server
+     */
     async loadLuaScripts() {
         let luaDirName;
         if (this.noLegacyMultihost && this.useSets) {