CrazyOrr/timber-js


JavaScript port of Android's timber library.

License: ISC

Language: TypeScript

Keywords: javascript, log, logger, timber


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.

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;
  }

  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()); ...

Installation

$ npm install @crazyorr/timber

Author

License

This project is licensed under the ISC License

Project Statistics

Sourcerank 3
Repository Size 61.5 KB
Stars 0
Forks 0
Watchers 1
Open issues 0
Dependencies 302
Contributors 1
Tags 6
Created
Last updated
Last pushed

Top Contributors See all

Lei Wang

Packages Referencing this Repo

@crazyorr/timber
JavaScript port of Android's timber library.
Latest release 0.1.0 - Updated

Recent Tags See all

v0.1.0 August 29, 2019
v0.0.5 April 24, 2019
v0.0.4 April 11, 2019
v0.0.3 February 23, 2019
v0.0.2 February 23, 2019
v0.0.1 February 23, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-08-29 22:42:34 UTC

Login to resync this repository