timber.js

JavaScript port of Android's timber library.

Behavior is added through Tree instances. You can install an instance by calling Timber.plant(). Installation of Trees should be done as early as possible.

Installation

$ npm install @crazyorr/timber

Usage

Two easy steps:

1. Install any Tree instances you want.
2. Call Timber's static methods everywhere.

Code Demo

Basic Usage

// import timber
const { Timber, DebugTree } = require("@crazyorr/timber");

// Plant a default debug tree which directs logs to console
Timber.plant(new DebugTree());

// Log without tag
Timber.debug("debug");
Timber.info("info");
Timber.warn("warn");
Timber.error("error");

// Chaining tag with log
Timber.tag("tag-1").debug("debug");
Timber.tag("tag-2").info("info");
Timber.tag("tag-3").warn("warn");
Timber.tag("tag-4").error("error");

Customize Tree

// import timber
const { Timber, Tree, Level } = require("@crazyorr/timber");

// Customize a tree's behavior by extending the Tree class, send logs to anywhere you want
class CustomTree extends Tree {
  isLoggable(level, tag) {
    // Log only if level is Warn or Error
    return level === Level.Warn || level === Level.Error;
  }

  log(level, tag, message, ...optionalParams) {
    switch (level) {
      case Level.Debug:
        break;
      case Level.Info:
        break;
      case Level.Warn:
        // Report warning...
        break;
      case Level.Error:
        // Report error...
        break;
    }
  }
}

// Plant a customized tree
Timber.plant(new CustomTree());
// You can plant as many trees as you want
// Timber.plant(new CustomTree()); ...

Author

• CrazyOrr

License

This project is licensed under the ISC License