@iobroker/socket-classes 0.5.3 → 0.5.4

package/lib/socketCommands.js

@@ -483,7 +483,7 @@ class SocketCommands {
 
     _subscribeStates(socket, pattern, callback) {
         if (this._checkPermissions(socket, 'subscribe', callback, pattern)) {
-            if (pattern && typeof pattern === 'object' && pattern instanceof Array) {
+            if (Array.isArray(pattern)) {
                 for (let p = 0; p < pattern.length; p++) {
                     this.subscribe(socket, 'stateChange', pattern[p]);
                 }
@@ -515,7 +515,7 @@ class SocketCommands {
 
     _subscribeFiles(socket, id, pattern, callback) {
         if (this._checkPermissions(socket, 'subscribeFiles', callback, pattern)) {
-            if (pattern && typeof pattern === 'object' && pattern instanceof Array) {
+            if (Array.isArray(pattern)) {
                 for (let p = 0; p < pattern.length; p++) {
                     this.subscribe(socket, 'fileChange', id, pattern[p]);
                 }
@@ -531,12 +531,12 @@ class SocketCommands {
 
     _unsubscribeFiles(socket, id, pattern, callback) {
         if (this._checkPermissions(socket, 'unsubscribeFiles', callback, pattern)) {
-            if (pattern && typeof pattern === 'object' && pattern instanceof Array) {
+            if (Array.isArray(pattern)) {
                 for (let p = 0; p < pattern.length; p++) {
                     this.unsubscribe(socket, 'fileChange', id, pattern[p]);
                 }
             } else {
-                this.unsubscribe(socket, 'fileChange', pattern);
+                this.unsubscribe(socket, 'fileChange', id, pattern);
             }
 
             this.adapter.log.level === 'debug' && this._showSubscribes(socket, 'fileChange');
@@ -595,6 +595,10 @@ class SocketCommands {
 
     __initCommandsCommon() {
         this.commands['authenticate'] = (socket, user, pass, callback) => {
+            // Authenticate user by login and password
+            // @param {string} user - user name
+            // @param {string} pass - password
+            // @param {function} callback - `function (isUserAuthenticated, isAuthenticationUsed)`
             if (socket && socket.___socket) {
                 socket = socket.___socket;
             }
@@ -615,10 +619,15 @@ class SocketCommands {
         };
 
         this.commands['error'] = (socket, error) => {
+            // Write error into ioBroker log
+            // @param {string} error - error text
             this.adapter.log.error('Socket error: ' + error);
         };
 
         this.commands['log'] = (socket, text, level) => {
+            // Write log entry into ioBroker log
+            // @param {string} text - log text
+            // @param {string} level - one of `['silly', 'debug', 'info', 'warn', 'error']`. Default is 'debug'.
             if (level === 'error') {
                 this.adapter.log.error(text);
             } else if (level === 'warn') {
@@ -632,6 +641,10 @@ class SocketCommands {
 
         // new History
         this.commands['getHistory'] = (socket, id, options, callback) => {
+            // Get history data from specific instance
+            // @param {string} id - object ID
+            // @param {object} options - See object description here: https://github.com/ioBroker/ioBroker.history/blob/master/docs/en/README.md#access-values-from-javascript-adapter
+            // @param {function} callback - `function (error, result)`
             if (this._checkPermissions(socket, 'getStateHistory', callback, id)) {
                 if (typeof options === 'string') {
                     options = {
@@ -653,6 +666,9 @@ class SocketCommands {
 
         // HTTP
         this.commands['httpGet'] = (socket, url, callback) => {
+            // Read content of HTTP(S) page server-side (without CORS and stuff)
+            // @param {string} url - Page URL
+            // @param {function} callback - `function (error, {status, statusText}, body)`
             if (this._checkPermissions(socket, 'httpGet', callback, url)) {
                 axios = axios || require('axios');
                 this.adapter.log.debug('httpGet: ' + url);
@@ -672,6 +688,11 @@ class SocketCommands {
 
         // commands
         this.commands['sendTo'] = (socket, adapterInstance, command, message, callback) => {
+            // Send message to specific instance
+            // @param {string} adapterInstance - instance name, e.g. `history.0`
+            // @param {string} command - command name
+            // @param {object} message - message is instance dependent
+            // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, 'sendTo', callback, command)) {
                 try {
                     this.adapter.sendTo(adapterInstance, command, message, res =>
@@ -687,8 +708,12 @@ class SocketCommands {
         const protectedCommands = ['cmdExec', 'getLocationOnDisk', 'getDiagData', 'getDevList', 'delLogs', 'writeDirAsZip', 'writeObjectsAsZip', 'readObjectsAsZip', 'checkLogging', 'updateMultihost', 'rebuildAdapter'];
 
         this.commands['sendToHost'] = (socket, host, command, message, callback) => {
-            // host can answer following commands: cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo,
-            // delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost
+            // Send message to specific host.
+            // Host can answer following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
+            // @param {string} host - instance name, e.g. `history.0`
+            // @param {string} command - command name
+            // @param {object} message - message is command specific
+            // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, protectedCommands.includes(command) ? 'cmdExec' : 'sendToHost', callback, command)) {
                 // Try to decode this file locally as redis has a limitation for files bigger than 20MB
                 if (command === 'writeDirAsZip' && message && message.data.length > 1024 * 1024) {
@@ -733,6 +758,8 @@ class SocketCommands {
         };
 
         this.commands['authEnabled'] = (socket, callback) => {
+            // Ask server is authentication enabled and if the user authenticated
+            // @param {function} callback - `function (isAuthenticationUsed, userName)`
             if (this._checkPermissions(socket, 'authEnabled', callback)) {
                 if (typeof callback === 'function') {
                     callback(this.adapter.config.auth, (socket._acl.user || '').replace(/^system\.user\./, ''));
@@ -743,10 +770,14 @@ class SocketCommands {
         };
 
         this.commands['logout'] = (socket, callback) => {
+            // Logout user
+            // @param {function} callback - function (error)
             this.adapter.destroySession(socket._sessionID, callback);
         };
 
         this.commands['listPermissions'] = (socket, callback) => {
+            // List commands and permissions
+            // @param {function} callback - `function (permissions)`
             if (typeof callback === 'function') {
                 callback(SocketCommands.COMMANDS_PERMISSIONS);
             } else {
@@ -755,6 +786,8 @@ class SocketCommands {
         };
 
         this.commands['getUserPermissions'] = (socket, callback) => {
+            // Get user permissions
+            // @param {function} callback - `function (error, permissions)`
             if (this._checkPermissions(socket, 'getUserPermissions', callback)) {
                 if (typeof callback === 'function') {
                     callback(null, socket._acl);
@@ -765,6 +798,8 @@ class SocketCommands {
         };
 
         this.commands['getVersion'] = (socket, callback) => {
+            // Get adapter version. Not the socket-classes version!
+            // @param {function} callback - `function (error, adapterVersion, adapterName)`
             if (this._checkPermissions(socket, 'getVersion', callback)) {
                 if (typeof callback === 'function') {
                     callback(null, this.adapter.version, this.adapter.name);
@@ -775,6 +810,8 @@ class SocketCommands {
         };
 
         this.commands['getAdapterName'] = (socket, callback) => {
+            // Get adapter name. Not the socket-classes version!
+            // @param {function} callback - `function (error, adapterVersion)`
             if (this._checkPermissions(socket, 'getAdapterName', callback)) {
                 if (typeof callback === 'function') {
                     callback(null, this.adapter.name || 'unknown');
@@ -783,12 +820,15 @@ class SocketCommands {
                 }
             }
         };
-
     }
 
     __initCommandsFiles() {
         // file operations
         this.commands['readFile'] = (socket, _adapter, fileName, callback) => {
+            // Read file from ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {function} callback - `function (error, data, mimeType)`
             if (this._checkPermissions(socket, 'readFile', callback, fileName)) {
                 try {
                     this.adapter.readFile(_adapter, fileName, {user: socket._acl.user}, (error, ...args) =>
@@ -801,6 +841,10 @@ class SocketCommands {
         };
 
         this.commands['readFile64'] = (socket, _adapter, fileName, callback) => {
+            // Read file from ioBroker DB as base64 string
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {function} callback - `function (error, base64, mimeType)`
             if (this._checkPermissions(socket, 'readFile64', callback, fileName)) {
                 try {
                     this.adapter.readFile(_adapter, fileName, {user: socket._acl.user}, (error, buffer, type) => {
@@ -836,6 +880,12 @@ class SocketCommands {
         };
 
         this.commands['writeFile64'] = (socket, _adapter, fileName, data64, options, callback) => {
+            // Write file into ioBroker DB as base64 string
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} data64 - file content as base64 string
+            // @param {object} options - optional `{mode: 0x0644}`
+            // @param {function} callback - `function (error)`
             if (typeof options === 'function') {
                 callback = options;
                 options = {user: socket._acl.user};
@@ -863,6 +913,12 @@ class SocketCommands {
 
         // this function is overloaded in admin (because admin accepts only base64)
         this.commands['writeFile'] = (socket, _adapter, fileName, data, options, callback) => {
+            // Write file into ioBroker DB as text **DEPRECATED**
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} data64 - file content as base64 string
+            // @param {object} options - optional `{mode: 0x644}`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'writeFile', callback, fileName)) {
                 if (typeof options === 'function') {
                     callback = options;
@@ -883,6 +939,10 @@ class SocketCommands {
         };
 
         this.commands['unlink'] = (socket, _adapter, name, callback) => {
+            // Delete file in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} name - file name, e.g `main/vis-views.json`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
                     this._unlink(_adapter, name, {user: socket._acl.user})
@@ -896,6 +956,10 @@ class SocketCommands {
         };
 
         this.commands['deleteFile'] = (socket, _adapter, name, callback) => {
+            // Delete file in ioBroker DB (same as unlink, but only for files)
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} name - file name, e.g `main/vis-views.json`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
                     this.adapter.unlink(_adapter, name, {user: socket._acl.user}, (error, ...args) =>
@@ -908,6 +972,10 @@ class SocketCommands {
         };
 
         this.commands['deleteFolder'] = (socket, _adapter, name, callback) => {
+            // Delete file in ioBroker DB (same as unlink, but only for folders)
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} name - folder name, e.g `main`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
                     this._unlink(_adapter, name, {user: socket._acl.user})
@@ -921,6 +989,11 @@ class SocketCommands {
         };
 
         this.commands['renameFile'] = (socket, _adapter, oldName, newName, callback) => {
+            // Rename file in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} oldName - current file name, e.g `main/vis-views.json`
+            // @param {string} newName - new file name, e.g `main/vis-views-new.json`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'rename', callback, oldName)) {
                 try {
                     this.adapter.rename(_adapter, oldName, newName, {user: socket._acl.user}, (error, ...args) =>
@@ -933,6 +1006,11 @@ class SocketCommands {
         };
 
         this.commands['rename'] = (socket, _adapter, oldName, newName, callback) => {
+            // Rename file or folder in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} oldName - current file name, e.g `main/vis-views.json`
+            // @param {string} newName - new file name, e.g `main/vis-views-new.json`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'rename', callback, oldName)) {
                 try {
                     this._rename(_adapter, oldName, newName, {user: socket._acl.user})
@@ -946,6 +1024,10 @@ class SocketCommands {
         };
 
         this.commands['mkdir'] = (socket, _adapter, dirName, callback) => {
+            // Create folder in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} dirName - desired folder name, e.g `main`
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'mkdir', callback, dirName)) {
                 try {
                     this.adapter.mkdir(_adapter, dirName, {user: socket._acl.user}, (error, ...args) =>
@@ -958,6 +1040,11 @@ class SocketCommands {
         };
 
         this.commands['readDir'] = (socket, _adapter, dirName, options, callback) => {
+            // Read content of folder in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} dirName - folder name, e.g `main`
+            // @param {object} options - optional `{filter: '*'}` or `{filter: '*.json'}`
+            // @param {function} callback - `function (error, files)` where `files` is an array of objects, like `{file: 'vis-views.json', isDir: false, stats: {size: 123}, modifiedAt: 1661336290090, acl: {owner: 'system.user.admin', ownerGroup: 'system.group.administrator', permissions: 1632, read: true, write: true}`
             if (typeof options === 'function') {
                 callback = options;
                 options = {};
@@ -981,6 +1068,11 @@ class SocketCommands {
         };
 
         this.commands['chmodFile'] = (socket, _adapter, fileName, options, callback) => {
+            // Change file mode in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {object} options - `{mode: 0x644}` or 0x644. First digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+            // @param {function} callback - `function (error)`
             if (typeof options === 'function') {
                 callback = options;
                 options = {};
@@ -1004,6 +1096,11 @@ class SocketCommands {
         };
 
         this.commands['chownFile'] = (socket, _adapter, fileName, options, callback) => {
+            // Change file owner in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {object} options - `{owner: 'system.user.user', ownerGroup: ''system.group.administrator'}` or 'system.user.user'. If ownerGroup is not defined, it will be taken from owner.
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'chownFile', callback, fileName)) {
                 options = options || {};
                 options.user = socket._acl.user;
@@ -1018,6 +1115,10 @@ class SocketCommands {
         };
 
         this.commands['fileExists'] = (socket, _adapter, fileName, callback) => {
+            // Checks if the file or folder exists in ioBroker DB
+            // @param {string} _adapter - instance name, e.g. `vis.0`
+            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {function} callback - `function (error, isExist)`
             if (this._checkPermissions(socket, 'fileExists', callback, fileName)) {
                 try {
                     this.adapter.fileExists(_adapter, fileName, {user: socket._acl.user}, (error, ...args) =>
@@ -1029,11 +1130,27 @@ class SocketCommands {
             }
         };
 
-        this.commands['subscribeFiles'] = (socket, id, pattern, callback) => this._subscribeFiles(socket, id, pattern, callback);
+        this.commands['subscribeFiles'] = (socket, id, pattern, callback) => {
+            // Subscribe on file changes in ioBroker DB
+            // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
+            // @param {string} pattern - file name pattern, e.g `main/*.json`
+            // @param {function} callback - `function (error)`
+            return this._subscribeFiles(socket, id, pattern, callback);
+        }
 
-        this.commands['unsubscribeFiles'] = (socket, id, pattern, callback) => this._unsubscribeFiles(socket, id, pattern, callback);
+        this.commands['unsubscribeFiles'] = (socket, id, pattern, callback) => {
+            // Unsubscribe on file changes in ioBroker DB
+            // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
+            // @param {string} pattern - file name pattern, e.g `main/*.json`
+            // @param {function} callback - `function (error)`
+
+            return this._unsubscribeFiles(socket, id, pattern, callback);
+        }
 
         this.commands['getAdapterInstances'] = (socket, adapterName, callback) => {
+            // Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
+            // @param {string} adapterName - optional adapter name, e.g `history`.
+            // @param {function} callback - `function (error, instanceList)`, where instanceList is an array of instance objects, e.g. `{_id: 'system.adapter.history.0', common: {name: 'history', ...}, native: {...}}`
             if (typeof callback === 'function') {
                 if (this._checkPermissions(socket, 'getObject', callback)) {
                     let _adapterName = adapterName !== undefined && adapterName !== null ? adapterName : this.adapterName || '';
@@ -1071,6 +1188,9 @@ class SocketCommands {
 
     __initCommandsStates() {
         this.commands['getStates'] = (socket, pattern, callback) => {
+            // Read states by pattern
+            // @param {string} pattern - optional pattern, like `system.adapter.*` or array of state IDs
+            // @param {function} callback - `function (error, states)`, where `states` is an object like `{'system.adapter.history.0': {_id: 'system.adapter.history.0', common: {name: 'history', ...}, native: {...}, 'system.adapter.history.1': {...}}}`
             if (this._checkPermissions(socket, 'getStates', callback, pattern)) {
                 if (typeof pattern === 'function') {
                     callback = pattern;
@@ -1092,7 +1212,10 @@ class SocketCommands {
 
         // this function is overloaded in admin
         this.commands['delObject'] = (socket, id, options, callback) => {
-            // only flot allowed
+            // Delete object. Only deletion of flot objects is allowed
+            // @param {string} id - Object ID like, 'flot.0.myChart'
+            // @param {string} options - ignored
+            // @param {function} callback - `function (error)`
             if (id.startsWith('flot.')) {
                 if (this._checkPermissions(socket, 'delObject', callback, id)) {
                     try {
@@ -1109,6 +1232,9 @@ class SocketCommands {
         };
 
         this.commands['getState'] = (socket, id, callback) => {
+            // Read one state.
+            // @param {string} id - State ID like, 'system.adapter.admin.0.memRss'
+            // @param {function} callback - `function (error, state)`, where `state` is an object like `{val: 123, ts: 1663915537418, ack: true, from: 'system.adapter.admin.0', q: 0, lc: 1663915537418, c: 'javascript.0'}`
             if (this._checkPermissions(socket, 'getState', callback, id)) {
                 if (typeof callback === 'function') {
                     if (this.states && this.states[id]) {
@@ -1129,6 +1255,10 @@ class SocketCommands {
         };
 
         this.commands['setState'] = (socket, id, state, callback) => {
+            // Write one state.
+            // @param {string} id - State ID like, 'system.adapter.admin.0.memRss'
+            // @param {any} state - value or object like `{val: 123, ack: true}`
+            // @param {function} callback - `function (error, state)`, where `state` is an object like `{val: 123, ts: 1663915537418, ack: true, from: 'system.adapter.admin.0', q: 0, lc: 1663915537418, c: 'javascript.0'}`
             if (this._checkPermissions(socket, 'setState', callback, id)) {
                 if (typeof state !== 'object') {
                     state = {val: state};
@@ -1150,6 +1280,9 @@ class SocketCommands {
         };
 
         this.commands['getBinaryState'] = (socket, id, callback) => {
+            // Read one binary state.
+            // @param {string} id - State ID like, 'javascript.0.binary'
+            // @param {function} callback - `function (error, base64)`
             if (this._checkPermissions(socket, 'getState', callback, id)) {
                 if (typeof callback === 'function') {
                     try {
@@ -1187,6 +1320,10 @@ class SocketCommands {
         };
 
         this.commands['setBinaryState'] = (socket, id, base64, callback) => {
+            // Write one binary state.
+            // @param {string} id - State ID like, 'javascript.0.binary'
+            // @param {string} base64 - State value as base64 string. Binary states has no acknowledge flag.
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'setState', callback, id)) {
                 if (typeof callback === 'function') {
                     let data = null;
@@ -1214,15 +1351,38 @@ class SocketCommands {
             }
         };
 
-        this.commands['subscribe'] = (socket, pattern, callback) => this._subscribeStates(socket, pattern, callback);
-        this.commands['subscribeStates'] = (socket, pattern, callback) => this._subscribeStates(socket, pattern, callback);
+        this.commands['subscribe'] = (socket, pattern, callback) => {
+            // Subscribe on state changes by pattern. The events will come as 'stateChange' events to the socket.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
+            return this._subscribeStates(socket, pattern, callback);
+        }
+        this.commands['subscribeStates'] = (socket, pattern, callback) => {
+            // Subscribe on state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
+            return this._subscribeStates(socket, pattern, callback);
+        }
 
-        this.commands['unsubscribe'] = (socket, pattern, callback) => this._unsubscribeStates(socket, pattern, callback);
-        this.commands['unsubscribeStates'] = (socket, pattern, callback) => this._unsubscribeStates(socket, pattern, callback);
+        this.commands['unsubscribe'] = (socket, pattern, callback) => {
+            // Unsubscribe from state changes by pattern.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
+            return this._unsubscribeStates(socket, pattern, callback);
+        }
+        this.commands['unsubscribeStates'] = (socket, pattern, callback) => {
+            // Unsubscribe from state changes by pattern. Same as `unsubscribe`.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
+            return this._unsubscribeStates(socket, pattern, callback);
+        }
     }
 
     __initCommandsObjects() {
         this.commands['getObject'] = (socket, id, callback) => {
+            // Get one object
+            // @param {string} id - object ID.
+            // @param {function} callback - `function (error, obj)`
             if (this._checkPermissions(socket, 'getObject', callback, id)) {
                 try {
                     this.adapter.getForeignObject(id, {user: socket._acl.user}, (error, obj) => {
@@ -1241,6 +1401,9 @@ class SocketCommands {
 
         // not admin version of "all objects"
         this.commands['getObjects'] = (socket, callback) => {
+            // Get all objects that are relevant for web: all states and enums with rooms
+            // @param {string} id - object ID.
+            // @param {function} callback - `function (error, obj)`
             if (this._checkPermissions(socket, 'getObjects', callback)) {
                 try {
                     this.adapter.getForeignObjects('*', 'state', 'rooms', {user: socket._acl.user}, (error, objs) => {
@@ -1263,6 +1426,9 @@ class SocketCommands {
         };
 
         this.commands['subscribeObjects'] = (socket, pattern, callback) => {
+            // Subscribe on object changes by pattern. The events will come as 'objectChange' events to the socket.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'subscribeObjects', callback, pattern)) {
                 try {
                     if (pattern && typeof pattern === 'object' && pattern instanceof Array) {
@@ -1284,6 +1450,9 @@ class SocketCommands {
         };
 
         this.commands['unsubscribeObjects'] = (socket, pattern, callback) => {
+            // Unsubscribe on object changes by pattern.
+            // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unsubscribeObjects', callback, pattern)) {
                 try {
                     if (pattern && typeof pattern === 'object' && pattern instanceof Array) {
@@ -1305,6 +1474,11 @@ class SocketCommands {
         };
 
         this.commands['getObjectView'] = (socket, design, search, params, callback) => {
+            // Make a query to the object database.
+            // @param {string} design - 'system' or other designs like `custom`, but it must exist object `_design/custom`. Too 99,9% use `system`.
+            // @param {string} search - object type, like `state`, `instance`, `adapter`, `host`, ...
+            // @param {string} params - parameters for the query in form `{startkey: 'system.adapter.', endkey: 'system.adapter.\u9999'}`
+            // @param {function} callback - `function (error)`
             if (typeof callback === 'function') {
                 if (this._checkPermissions(socket, 'getObjectView', callback, search)) {
                     try {
@@ -1320,6 +1494,10 @@ class SocketCommands {
         };
 
         this.commands['setObject'] = (socket, id, obj, callback) => {
+            // Set object.
+            // @param {string} id - object ID
+            // @param {object} obj - object itself
+            // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'setObject', callback, id)) {
                 try {
                     this.adapter.setForeignObject(id, obj, {user: socket._acl.user}, (error, ...args) =>