webgme-engine

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: docs/def.doc.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: docs/def.doc.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * A promise object provided by the [q]{@link https://github.com/kriskowal/q/wiki/API-Reference} promise library. * @example * aPromise * .then(function (result) { * //process result * }) * .catch(function (error) { * //process error * }); * @external Promise */ /** * @description JavaScript Error class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error}. * @typedef {object} Error * @prop {string} message - Message typically set in the constructor. * @prop {stack} stack - Detailed stack trace. */ /** * @description Javascript Object class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object}. * @typedef {object} object */ /** * @description Javascript String class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String}. * @typedef {string} string */ /** * @description Javascript null literal. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null}. * @typedef {null} null */ /** * @description Javascript undefined literal. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined}. * @typedef {undefined} undefined */ /** * @description Javascript Boolean class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean} * @typedef {boolean} boolean */ /** * @description Javascript Array class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array}. * @typedef {Array} Array */ /** * @description Javascript function class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function}. * @typedef {function} function */ /** * @description Javascript Number class. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number}. * @typedef {number} number */ /** * @description Represents an integer from the Number class of Javascript. For more information, look up the * [reference]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number}. * @typedef {integer} integer */ /** * @description The main configuration object of the WebGME. For detailed information about the individual * options, look up the [wiki]{@link https://github.com/webgme/webgme/tree/master/config/README.md} pages. * @typedef {object} GmeConfig * @prop {object} addOn - Add-on related settings. * @prop {object} authentication - Authentication related settings. * @prop {object} bin - Bin script related settings. * @prop {object} blob - Blob related settings. * @prop {object} client - Client related settings. * @prop {object} core - Client related settings. * @prop {boolean} debug - Enables debug mode. * @prop {object} executor - Executor related settings. * @prop {object} mongo - Mongo database related settings. * @prop {object} plugin - Plugin related settings. * @prop {object} requirejsPaths - Additional paths to for requirejs. * @prop {object} rest - REST related settings. * @prop {object} seedProjects - Seed related settings. * @prop {object} server - Server related settings. * @prop {object} socketIO - Socket IO related settings. * @prop {object} storage - Storage related settings. * @prop {object} visualization - Visualization related settings. */ /** * @description Describes common API for loggers on both client and server side. * @class GmeLogger */ /** * @description Logs debug message. * @function debug * @memberOf GmeLogger * @instance * * @param {...*} message - The message of the log. */ /** * @description Logs info message * @function info * @memberOf GmeLogger * @instance * * @param {...*} message - The message of the log. */ /** * @description Logs warning message * @function warn * @memberOf GmeLogger * @instance * * @param {...*} message - The message of the log. */ /** * @description Logs error message * @function error * @memberOf GmeLogger * @instance * * @param {...*} message - The message of the log. */ /** * @description Creates a new logger with the same settings * and a name that is an augmentation of this logger and the provided string. If the second argument is true - * the provided name will be used as is. * @function fork * @memberOf GmeLogger * @instance * * @param {string} name - The augmentation of the initial namespace of the logger. * @param {boolean} [asIs=false] - If true it will be a replacement of the original namespace. * * @return {GmeLogger} The resulting logger. */ </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>