Package Exports

electron-log

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (electron-log) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

electron-log

Description

Just a very simple logging module for your Electron application. No dependencies. No complicated configuration. Just require and use. Also it can be used without Electron.

By default it writes logs to the following locations:

on Linux: ~/.config/<app name>/log.log
on OS X: ~/Library/Logs/<app name>/log.log
on Windows: $HOME/AppData/Roaming/<app name>/log.log

Installation

Install with npm:

npm install electron-log

Usage

var log = require('electron-log');

log.info('Hello, log');

Transport

Transport is a simple function which requires an object which describes a message. By default, two transports is active: console and file. The file path is depend on current platform.

Disable default transport:

log.transports.file = false;
log.transports.console = false;

Override transport:

log.transports.console = function(msg) {
  console.log(`[${msg.date.toLocaleTimeString()} ${msg.level}] ${msg.text}`);
};

Console Transport

// Log level
log.transports.console.level = 'warning';

/** 
 * Set output format template. Available variables:
 * Main: {level}, {text}
 * Date: {y},{m},{d},{h},{i},{s},{ms}
 */
log.transports.console.format = '{h}:{i}:{s}:{ms} {text}';

// Set a function which formats output
log.transports.console.format = (msg) => msg.text;

File transport

// Same as for console transport
log.transports.file.level = 'warning';
log.transports.file.format = '{h}:{i}:{s}:{ms} {text}';

// Set maximum log size in bytes. When it exceeds, old log will be saved
// as log.old.log file
log.transports.file.maxSize = 5 * 1024 * 1024;

// Write to this file, must be set before first logging
log.transports.file.file = __dirname + '/log.txt';

// fs.createWriteStream options, must be set before first logging
log.transports.file.streamConfig = { flags: 'w' };

// set existed file stream
log.transports.file.stream = fs.createWriteStream('log.txt');

By default, file transport reads a name property from package.json to determine a log path like ~/.config/<app name>/log.log. If you have no package.json or you want to specify another , just set the appName property:

log.appName = 'test';

License

Licensed under MIT.