1. module electron-log
   1. function electron-log.debug ()
   2. function electron-log.error ()
   3. function electron-log.info ()
   4. function electron-log.silly ()
   5. function electron-log.transports.console (msg)
   6. function electron-log.transports.file (msg)
   7. function electron-log.transports.rendererConsole (msg)
   8. function electron-log.verbose ()
   9. function electron-log.warn ()
   10. object electron-log.format
   11. object electron-log.main
   12. object electron-log.transports
2. module electron-log.format
   1. function electron-log.format (msg, formatter)
   2. function electron-log.format.pad (number, zeros)
   3. function electron-log.format.stringifyArray (data)
3. module electron-log.main
   1. function electron-log.main.debug ()
   2. function electron-log.main.error ()
   3. function electron-log.main.info ()
   4. function electron-log.main.silly ()
   5. function electron-log.main.verbose ()
   6. function electron-log.main.warn ()
   7. object electron-log.main.transports
4. module electron-log.transports
   1. function electron-log.transports.console (msg)
   2. function electron-log.transports.file (msg)
   3. function electron-log.transports.logS (msg)
   4. function electron-log.transports.rendererConsole (msg)
5. module electron-log.transports.console
   1. function electron-log.transports.console (msg)
   2. function electron-log.transports.console.format (msg)
   3. string electron-log.transports.console.level
6. module electron-log.transports.file
   1. function electron-log.transports.file (msg)
   2. function electron-log.transports.file.findLogPath (appName)
   3. function electron-log.transports.file.format (msg)
   4. number electron-log.transports.file.maxSize
   5. string electron-log.transports.file.level
7. module electron-log.transports.rendererConsole
   1. boolean electron-log.transports.rendererConsole.level
   2. function electron-log.transports.rendererConsole (msg)
   3. function electron-log.transports.rendererConsole.format (msg)

module electron-log

function electron-log.debug ()

• description and source-code

  debug = function () { [native code] }

• example usage

  n/a

function electron-log.error ()

• description and source-code

  error = function () { [native code] }

• example usage

  n/a

function electron-log.info ()

• description and source-code

  info = function () { [native code] }

• example usage

  ...
  npm install electron-log
  
  ## Usage
  
  ```js
  var log = require('electron-log');
  
  log.info('Hello, log');
  ```
  ### Log levels
  
  electron-log supports the following log levels:
  
  error, warn, info, verbose, debug, silly
  ...

function electron-log.silly ()

• description and source-code

  silly = function () { [native code] }

• example usage

  n/a

function electron-log.transports.console (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format);
    if (console[msg.level]) {
      console[msg.level](text);
    } else {
      console.log(text);
    }
  }

• example usage

  n/a

function electron-log.transports.file (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format) + EOL;
  
    if (transport.stream === undefined) {
      initSteamConfig();
      openStream();
    }
  
    if (transport.level === false) {
      return;
    }
  
    var needLogRotation = transport.maxSize > 0 &&
      getStreamSize(transport.stream) > transport.maxSize;
  
    if (needLogRotation) {
      archiveLog(transport.stream);
      openStream();
    }
  
    transport.stream.write(text);
  }

• example usage

  n/a

function electron-log.transports.rendererConsole (msg)

• description and source-code

  function transport(msg) {
    if (!BrowserWindow) return;
  
    var text = format.format(msg, transport.format);
    BrowserWindow.getAllWindows().forEach(function(wnd) {
      wnd.webContents.send('__ELECTRON_LOG_RENDERER__', msg.level, text);
    });
  }

• example usage

  n/a

function electron-log.verbose ()

• description and source-code

  verbose = function () { [native code] }

• example usage

  n/a

function electron-log.warn ()

• description and source-code

  warn = function () { [native code] }

• example usage

  n/a

module electron-log.format

function electron-log.format (msg, formatter)

• description and source-code

  function format(msg, formatter) {
    if (typeof formatter === 'function') {
      return formatter(msg);
    }
  
    var date = msg.date;
  
    return formatter
      .replace('{level}', msg.level)
      .replace('{text}', stringifyArray(msg.data))
      .replace('{y}', date.getFullYear())
      .replace('{m}', pad(date.getMonth() + 1))
      .replace('{d}', pad(date.getDate()))
      .replace('{h}', pad(date.getHours()))
      .replace('{i}', pad(date.getMinutes()))
      .replace('{s}', pad(date.getSeconds()))
      .replace('{ms}', pad(date.getMilliseconds(), 4));
  }

• example usage

  n/a

function electron-log.format.pad (number, zeros)

• description and source-code

  function pad(number, zeros) {
    zeros = zeros || 2;
    return (new Array(zeros + 1).join('0') + number).substr(-zeros, zeros);
  }

• example usage

  n/a

function electron-log.format.stringifyArray (data)

• description and source-code

  function stringifyArray(data) {
    data = data.map(function formatErrors(arg) {
      return arg instanceof Error ? arg.stack + EOL : arg;
    });
    return util.format.apply(util, data);
  }

• example usage

  n/a

module electron-log.main

function electron-log.main.debug ()

• description and source-code

  debug = function () { [native code] }

• example usage

  n/a

function electron-log.main.error ()

• description and source-code

  error = function () { [native code] }

• example usage

  n/a

function electron-log.main.info ()

• description and source-code

  info = function () { [native code] }

• example usage

  ...
  npm install electron-log
  
  ## Usage
  
  ```js
  var log = require('electron-log');
  
  log.info('Hello, log');
  ```
  ### Log levels
  
  electron-log supports the following log levels:
  
  error, warn, info, verbose, debug, silly
  ...

function electron-log.main.silly ()

• description and source-code

  silly = function () { [native code] }

• example usage

  n/a

function electron-log.main.verbose ()

• description and source-code

  verbose = function () { [native code] }

• example usage

  n/a

function electron-log.main.warn ()

• description and source-code

  warn = function () { [native code] }

• example usage

  n/a

module electron-log.transports

function electron-log.transports.console (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format);
    if (console[msg.level]) {
      console[msg.level](text);
    } else {
      console.log(text);
    }
  }

• example usage

  n/a

function electron-log.transports.file (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format) + EOL;
  
    if (transport.stream === undefined) {
      initSteamConfig();
      openStream();
    }
  
    if (transport.level === false) {
      return;
    }
  
    var needLogRotation = transport.maxSize > 0 &&
      getStreamSize(transport.stream) > transport.maxSize;
  
    if (needLogRotation) {
      archiveLog(transport.stream);
      openStream();
    }
  
    transport.stream.write(text);
  }

• example usage

  n/a

function electron-log.transports.logS (msg)

• description and source-code

  function transport(msg) {
    if (!transport.url) return;
  
    var data = jsonDepth({
      client: transport.client,
      data: msg.data,
      date: msg.date.getTime(),
      level: msg.level
    }, transport.depth + 1);
  
    post(transport.url, data);
  }

• example usage

  n/a

function electron-log.transports.rendererConsole (msg)

• description and source-code

  function transport(msg) {
    if (!BrowserWindow) return;
  
    var text = format.format(msg, transport.format);
    BrowserWindow.getAllWindows().forEach(function(wnd) {
      wnd.webContents.send('__ELECTRON_LOG_RENDERER__', msg.level, text);
    });
  }

• example usage

  n/a

module electron-log.transports.console

function electron-log.transports.console (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format);
    if (console[msg.level]) {
      console[msg.level](text);
    } else {
      console.log(text);
    }
  }

• example usage

  n/a

function electron-log.transports.console.format (msg)

• description and source-code

  function formatFn(msg) {
    var time =
      format.pad(msg.date.getHours()) + ':' +
      format.pad(msg.date.getMinutes()) + ':' +
      format.pad(msg.date.getSeconds()) + ':' +
      format.pad(msg.date.getMilliseconds(), 4);
  
    return '[' + time + '] [' + msg.level + '] ' +
      format.stringifyArray(msg.data);
  }

• example usage

  n/a

module electron-log.transports.file

function electron-log.transports.file (msg)

• description and source-code

  function transport(msg) {
    var text = format.format(msg, transport.format) + EOL;
  
    if (transport.stream === undefined) {
      initSteamConfig();
      openStream();
    }
  
    if (transport.level === false) {
      return;
    }
  
    var needLogRotation = transport.maxSize > 0 &&
      getStreamSize(transport.stream) > transport.maxSize;
  
    if (needLogRotation) {
      archiveLog(transport.stream);
      openStream();
    }
  
    transport.stream.write(text);
  }

• example usage

  n/a

function electron-log.transports.file.findLogPath (appName)

• description and source-code

  function findLogPath(appName) {
    appName = appName || getAppName();
    if (!appName) {
      return false;
    }
  
    var dir;
    switch (process.platform) {
      case 'linux': {
        dir = prepareDir(process.env['XDG_CONFIG_HOME'], appName)
          .or(process.env['HOME'], '.config', appName)
          .or(process.env['XDG_DATA_HOME'], appName)
          .or(process.env['HOME'], '.local', 'share', appName)
          .result;
        break;
      }
  
      case 'darwin': {
        dir = prepareDir(process.env['HOME'], 'Library', 'Logs', appName)
          .or(process.env['HOME'], 'Library', 'Application Support', appName)
          .result;
        break;
      }
  
      case 'win32': {
        dir = prepareDir(process.env['APPDATA'], appName)
          .or(process.env['USERPROFILE'], 'AppData', 'Roaming', appName)
          .result;
        break;
      }
    }
  
    if (dir) {
      return path.join(dir, 'log.log');
    } else {
      return false;
    }
  }

• example usage

  n/a

function electron-log.transports.file.format (msg)

• description and source-code

  function formatFn(msg) {
    var date =
      msg.date.getFullYear() + '-' +
      format.pad(msg.date.getMonth() + 1) + '-' +
      format.pad(msg.date.getDate()) + ' ' +
      format.pad(msg.date.getHours()) + ':' +
      format.pad(msg.date.getMinutes()) + ':' +
      format.pad(msg.date.getSeconds()) + ':' +
      format.pad(msg.date.getMilliseconds(), 4);
  
    return '[' + date + '] [' + msg.level + '] ' +
      format.stringifyArray(msg.data);
  }

• example usage

  n/a

module electron-log.transports.rendererConsole

function electron-log.transports.rendererConsole (msg)

• description and source-code

  function transport(msg) {
    if (!BrowserWindow) return;
  
    var text = format.format(msg, transport.format);
    BrowserWindow.getAllWindows().forEach(function(wnd) {
      wnd.webContents.send('__ELECTRON_LOG_RENDERER__', msg.level, text);
    });
  }

• example usage

  n/a

function electron-log.transports.rendererConsole.format (msg)

• description and source-code

  function formatFn(msg) {
    var time =
          format.pad(msg.date.getHours()) + ':' +
          format.pad(msg.date.getMinutes()) + ':' +
          format.pad(msg.date.getSeconds()) + ':' +
          format.pad(msg.date.getMilliseconds(), 4);
  
    return '[' + time + '] ' + format.stringifyArray(msg.data);
  }

• example usage

  n/a