@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Source: lib/util/Logger.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class=""> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class=""> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class=""><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class=""> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Source: lib/util/Logger.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; const msg = require('../message'); const deprecated = require('./deprecated'); /** * A Logger to store log notes when running the app. * * @alias util.Logger */ class Logger { /** * Creates a Logger instance for the given EntityManager * @param {EntityManager} entityManager * @return {util.Logger} The created logger instance */ static create(entityManager) { const proto = this.prototype; // eslint-disable-next-line no-shadow function Logger() { proto.log.apply(Logger, arguments); } Object.getOwnPropertyNames(proto).forEach((key) => { Object.defineProperty(Logger, key, Object.getOwnPropertyDescriptor(proto, key)); }); Logger.init(entityManager); return Logger; } /** * The log level which will be logged * * The log level can be one of 'trace', 'debug', 'info', 'warn', 'error' * @type string */ get level() { return Logger.LEVELS[this.levelIndex]; } /** * Sets the log level which will be logged * @param {string} value */ set level(value) { const index = Logger.LEVELS.indexOf(value); if (index === -1) { throw new Error('Unknown logging level ' + value); } this.levelIndex = index; } /** * Logs a message in the default level 'info' * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {void} * * @name log * @memberOf util.Logger.prototype * @function * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Logs a message in the default level 'info' * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {void} * * @name log * @memberOf util.Logger.prototype * @function * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Logs a message with the given log level * @param {string} level The level used to log the message * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {void} * @name log * @memberOf util.Logger.prototype * @function * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Logs a message with the given log level * @param {string} level The level used to log the message * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * * @see https://nodejs.org/api/util.html#util_util_format_format */ log(/* level, message, data */) { const args = Array.prototype.slice.call(arguments); const level = Logger.LEVELS.indexOf(args[0]) === -1 ? 'info' : args.shift(); if (this.levelIndex > Logger.LEVELS.indexOf(level)) { return null; } let message = typeof args[0] === 'string' ? this.format(args.shift(), args) : '[no message]'; let data = null; if (args.length) { data = args.pop(); if (typeof data !== 'object' || Array.isArray(data)) { data = { data }; } if (data instanceof Error) { // errors aren't loggable by default, since they do not have any visible property data = { name: data.name, message: data.message, stack: data.stack, status: data.status, data: data.data, }; } } if (args.length) { message += ', ' + args.join(', '); } return this.logJSON({ date: new Date(), message, level, user: this.entityManager.me && this.entityManager.me.id, data, }); } format(message, args) { if (args.length === 0) { return message; } const str = String(message).replace(Logger.FORMAT_REGEXP, (x) => { if (x === '%%') { return '%'; } if (!args.length) { return x; } switch (x) { case '%s': return String(args.shift()); case '%d': return Number(args.shift()); case '%j': try { return JSON.stringify(args.shift()); } catch (_) { return '[Circular]'; } default: return x; } }); return str; } init(entityManager) { /** @type EntityManager */ this.entityManager = entityManager; this.levelIndex = 2; Logger.LEVELS.forEach((level) => { this[level] = this.log.bind(this, level); }); } logJSON(json) { if (!this.entityManager.isReady) { return this.entityManager.ready(this.logJSON.bind(this, json)); } return this.entityManager.send(new msg.CreateObject('logs.AppLog', json)); } } /** * Log message at trace level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function trace * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at trace level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function trace * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at debug level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function debug * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at debug level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function debug * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at info level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function info * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at info level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function info * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at warn level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function warn * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at warn level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function warn * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at error level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {...*} args The arguments used to interpolated the message string. The last param can be object which will * be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function error * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ /** * Log message at error level * @param {string} message The message to log, the message string can be interpolated like the node util.format method * @param {Object<string, *>} [data=null] An optional object which will be included in the log entry * @return {Promise<*>|null} A promise which resolves when the log messages was logged, or null if the log level has * skipped the message * @function error * @memberOf util.Logger.prototype * * @see https://nodejs.org/api/util.html#util_util_format_format */ Object.assign(Logger, { LEVELS: ['trace', 'debug', 'info', 'warn', 'error'], FORMAT_REGEXP: /%[sdj%]/g, }); deprecated(Logger.prototype, '_init', 'init'); deprecated(Logger.prototype, '_format', 'format'); deprecated(Logger.prototype, '_log', 'logJSON'); module.exports = Logger; </code></pre> </article> </section>  </div> </div> </div> </div> </div> <div id="footer" style="position:relative; z-index:1;"> <div class="container"> <div class="row"> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Product</h4> <a href="https://www.baqend.com/platform.html">Platform</a> <a href="https://www.baqend.com/speedkit.html">Speed Kit</a> <a href="https://www.baqend.com/features.html">Features</a> <a href="https://www.baqend.com/pricing.html">Platform Pricing</a> <a href="https://www.baqend.com/pricing_speedkit.html">Speed Kit Pricing</a> <a href="https://www.baqend.com/agencies.html">Agencies</a> <a href="https://www.baqend.com/enterprise.html">Enterprise</a> <a href="https://www.baqend.com/features.html#download">Community Edition</a> <a href="https://www.baqend.com/support.html">Support</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Company</h4> <a href="https://www.baqend.com/about.html">About us</a> <a href="https://medium.baqend.com">Baqend Blog</a> <a href="https://www.baqend.com/hiring.html">Jobs</a> <a href="https://www.baqend.com/press.html">Press</a> <a href="https://thesis.app.baqend.com/">Bachelor/Master theses</a> <a href="https://www.weblabs.hamburg/">WebLabs.Hamburg</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Developer</h4> <a href="https://dashboard.baqend.com/login">Login</a> <a href="https://dashboard.baqend.com/register">Sign Up</a> <a href="https://www.baqend.com/guide">Developer Docs</a> <a href="https://www.baqend.com/guide/roadmap/">Roadmap</a> <a href="https://www.baqend.com/guide/starter-kits">Starter Kits</a> <a href="https://www.baqend.com/js-sdk/latest/baqend.html">JS SDK</a> <a href="https://stackoverflow.com/questions/tagged/baqend/">Stackoverflow</a> </div> <div class="col-xs-6 col-sm-3 contact"> <h4>Contact</h4> <p class="contact-information"> <span> Baqend GmbH<br /> Stresemannstr. 23<br /> 22769 Hamburg<br /> Germany </span> </p> <p class="contact-information"> Email: <a style="display: inline-block" href="mailto:support@baqend.com">support@baqend.com</a> </p> <p class="contact-information"> Tel: <a style="display: inline-block" href="tel:+494060940539">+49 40 60940539</a> </p> </div> </div> <div class="row"> <div class="col-md-12 text-center social"> <a href="https://twitter.com/baqendcom"><i class="fa fa-twitter fa-fw"></i></a> <a href="https://github.com/Baqend"><i class="fa fa-github fa-fw"></i></a> <a href="https://medium.baqend.com/"><i class="fa fa-medium fa-fw"></i></a> <a href="https://www.facebook.com/baqend"><i class="fa fa-facebook fa-fw"></i></a> <a href="https://www.youtube.com/channel/UCsImg6Ts8UEp6-7LE9CP2-Q"><i class="fa fa-youtube fa-fw"></i></a> </div> </div> </div> <footer> <div class="container"> <div class="legal text-center"> <div> <strong>Baqend JavaScript SDK 2.14.1</strong><br> &copy 2019 Baqend GmbH<br> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun, 06 Jan 2019 05:00:21 GMT </div> <a href="mailto:info@baqend.com">Contact</a> - <a href="https://dashboard.baqend.com/privacy">Privacy Policy</a> - <a href="https://dashboard.baqend.com/terms">Terms of Service</a> - <a href="https://dashboard.baqend.com/imprint">Imprint</a> </div> </div> </footer> </div> <script> prettyPrint(); </script> <script src="https://code.jquery.com/jquery-1.12.1.min.js"></script> <script src="scripts/bootstrap.min.js"> </script> <script src="scripts/linenumber.js"> </script> <script src="scripts/filter.js"> </script> <script data-main="scripts/search.js" src="scripts/require.js"></script> </body> </html>