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

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

@@ -72,6 +72,9 @@ 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"}.`;
@@ -126,6 +129,9 @@ 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;
@@ -529,6 +535,9 @@ class ObjectsInRedisClient {
       }
     });
   }
+  /**
+   * Get the current status of the database
+   */
   getStatus() {
     return { type: "redis", server: false };
   }
@@ -551,6 +560,11 @@ 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;
   }
@@ -595,6 +609,13 @@ class ObjectsInRedisClient {
       await this.client.publish(id, "null");
     }
   }
+  /**
+   * 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);
     if (id.endsWith(".admin")) {
@@ -617,6 +638,15 @@ class ObjectsInRedisClient {
     name = normalized.name;
     return `${this.fileNamespace + id}$%$${name}${isMeta !== void 0 ? 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, options2, flag, callback) {
     const fileId = this.getFileId(id, name, true);
     if (!fileId) {
@@ -646,6 +676,15 @@ class ObjectsInRedisClient {
     }
     return import_db_base.tools.maybeCallback(callback, true, options2);
   }
+  /**
+   * 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, options2, flag, callback) {
     return utils.checkFileRights(this, id, name, options2, flag, callback);
   }
@@ -662,6 +701,11 @@ 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,
@@ -679,6 +723,12 @@ 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, user2, userGroups, userAcl) => {
       if (error) {
@@ -737,6 +787,15 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -773,6 +832,14 @@ class ObjectsInRedisClient {
       return this._writeFile(id, name, data, options3, 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, options2) {
     return new Promise((resolve, reject) => this.writeFile(id, name, data, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -791,6 +858,14 @@ class ObjectsInRedisClient {
     }
     return { file: buffer, 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -898,6 +973,14 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -927,12 +1010,34 @@ 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, options2) {
     return new Promise((resolve, reject) => this.unlink(id, name, options2, (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, options2, callback) {
     return this.unlink(id, name, options2, 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, options2) {
     return this.unlinkAsync(id, name, options2);
   }
@@ -1069,6 +1174,14 @@ class ObjectsInRedisClient {
     }
     return import_db_base.tools.maybeCallbackWithError(callback, null, result2);
   }
+  /**
+   * 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1096,6 +1209,13 @@ class ObjectsInRedisClient {
       this._readDir(id, name, options3, 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, options2) {
     return new Promise((resolve, reject) => this.readDir(id, name, options2, (err, res) => err ? reject(err) : resolve(res)));
   }
@@ -1197,6 +1317,15 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1230,6 +1359,14 @@ class ObjectsInRedisClient {
       this._rename(id, oldName, newName, options3, 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, options2) {
     return new Promise((resolve, reject) => this.rename(id, oldName, newName, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -1249,6 +1386,14 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1270,6 +1415,13 @@ 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, options2) {
     return new Promise((resolve, reject) => this.touch(id, name, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -1353,6 +1505,14 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1379,10 +1539,25 @@ 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, options2) {
     return new Promise((resolve, reject) => this.rm(id, name, options2, (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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1407,6 +1582,13 @@ class ObjectsInRedisClient {
       this.writeFile(id, `${realName}_data.json`, "", options3, 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, options2) {
     return new Promise((resolve, reject) => this.mkdir(id, dirName, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -1525,6 +1707,14 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1570,6 +1760,13 @@ class ObjectsInRedisClient {
       return this._chownFile(id, name, options3, 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, options2) {
     return new Promise((resolve, reject) => this.chownFile(id, name, options2, (err, processed) => err ? reject(err) : resolve(processed)));
   }
@@ -1692,6 +1889,14 @@ class ObjectsInRedisClient {
     }
     this._chmodFileHelper(keysFiltered, objsFiltered, options2, (err) => import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1723,9 +1928,23 @@ class ObjectsInRedisClient {
       return this._chmodFile(id, name, options3, 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, options2) {
     return new Promise((resolve, reject) => this.chmodFile(id, name, options2, (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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1741,6 +1960,12 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2) {
     return new Promise((resolve, reject) => this.enableFileCache(enabled, options2, (err, res) => err ? reject(err) : resolve(res)));
   }
@@ -1788,6 +2013,13 @@ 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, options2) {
     return new Promise((resolve, reject) => {
       utils.checkObjectRights(this, null, null, options2, "list", (err) => {
@@ -1799,6 +2031,13 @@ 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, options2) {
     return new Promise((resolve, reject) => {
       utils.checkObjectRights(this, null, null, options2, "list", (err) => {
@@ -1848,6 +2087,13 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1855,9 +2101,22 @@ class ObjectsInRedisClient {
     }
     return this.subscribeConfig(pattern, options2, 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, options2) {
     return new Promise((resolve, reject) => this.subscribe(pattern, options2, (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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1870,6 +2129,12 @@ 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, options2) {
     return new Promise((resolve, reject) => this.subscribeUser(pattern, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -1909,6 +2174,13 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1916,9 +2188,22 @@ class ObjectsInRedisClient {
     }
     return this.unsubscribeConfig(pattern, options2, 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, options2) {
     return new Promise((resolve, reject) => this.unsubscribe(pattern, options2, (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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1936,6 +2221,12 @@ 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, options2) {
     return new Promise((resolve, reject) => this.unsubscribeUser(pattern, options2, (err) => err ? reject(err) : resolve()));
   }
@@ -2022,6 +2313,13 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2062,6 +2360,12 @@ class ObjectsInRedisClient {
       return this._chownObject(pattern, options3, 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, options2) {
     return new Promise((resolve, reject) => this.chownObject(pattern, options2, (err, list) => err ? reject(err) : resolve(list)));
   }
@@ -2123,6 +2427,13 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2152,6 +2463,12 @@ class ObjectsInRedisClient {
       return this._chmodObject(pattern, options3, 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, options2) {
     return new Promise((resolve, reject) => this.chmodObject(pattern, options2, (err, list) => err ? reject(err) : resolve(list)));
   }
@@ -2186,6 +2503,13 @@ class ObjectsInRedisClient {
     }
     return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2207,9 +2531,10 @@ 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, options2) {
@@ -2278,6 +2603,14 @@ class ObjectsInRedisClient {
     }
     return import_db_base.tools.maybeCallbackWithError(callback, null, result2);
   }
+  /**
+   * 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, options2, callback, dontModify) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2295,8 +2628,14 @@ class ObjectsInRedisClient {
       });
     }
   }
-  getKeysAsync(id, options2) {
-    return this.getKeys(id, options2);
+  /**
+   * Promise-version of getKeys
+   *
+   * @param pattern The pattern to match object ids against
+   * @param options The current request options including the user
+   */
+  getKeysAsync(pattern, options2) {
+    return this.getKeys(pattern, options2);
   }
   async _getObjects(keys2, options2, callback, dontModify) {
     if (!keys2) {
@@ -2359,6 +2698,14 @@ class ObjectsInRedisClient {
     }
     return import_db_base.tools.maybeCallbackWithError(callback, null, result2);
   }
+  /**
+   * 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(keys2, options2, callback, dontModify) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2382,6 +2729,12 @@ 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(keys2, options2) {
     return this.getObjects(keys2, options2);
   }
@@ -2406,6 +2759,13 @@ class ObjectsInRedisClient {
     }
     this._getObjects(keys2, options2, 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2426,6 +2786,12 @@ 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, options2) {
     return new Promise((resolve, reject) => this.getObjectsByPattern(pattern, options2, (err, objs2) => err ? reject(err) : resolve(objs2)));
   }
@@ -2574,7 +2940,7 @@ 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
    */
@@ -2602,10 +2968,11 @@ 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, options2) {
@@ -2662,6 +3029,13 @@ 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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2685,6 +3059,12 @@ 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, options2) {
     return this.delObject(id, options2);
   }
@@ -3118,6 +3498,15 @@ 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, params2, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -3143,6 +3532,14 @@ 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, params2, options2) {
     return this.getObjectView(design, search, params2, options2);
   }
@@ -3202,6 +3599,13 @@ class ObjectsInRedisClient {
     }
     return result2;
   }
+  /**
+   * 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(params2, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -3227,6 +3631,12 @@ 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(params2, options2) {
     return this.getObjectList(params2, options2);
   }
@@ -3342,6 +3752,14 @@ class ObjectsInRedisClient {
       return import_db_base.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, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -3360,16 +3778,23 @@ class ObjectsInRedisClient {
       return this._extendObject(id, obj, options3, 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, options2) {
     return new Promise((resolve, reject) => this.extendObject(id, obj, options2 || 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, options2, callback) {
     this._getObject(idOrName, options2, (err, obj) => {
@@ -3413,6 +3838,14 @@ 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, options2, callback) {
     if (typeof type === "function") {
       callback = type;
@@ -3439,6 +3872,11 @@ 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];
@@ -3475,6 +3913,12 @@ class ObjectsInRedisClient {
       return import_db_base.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(options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -3491,10 +3935,17 @@ class ObjectsInRedisClient {
       return this._destroyDB(callback);
     });
   }
+  /**
+   * Promise-version of destroyDB
+   *
+   * @param options The current request options including the user
+   */
   destroyDBAsync(options2) {
     return new Promise((resolve, reject) => this.destroyDB(options2, (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) {
@@ -3522,6 +3973,9 @@ 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) {