Git Product home page Git Product logo

log4ts's Introduction

Log4ts

Log4ts is a client logging library inspired by Log4j and Log4js.

##Getting started

Installing from npm

npm install log4ts --save
typings install npm:log4ts --save --global

You can now import the majority of the log4ts classes from the 'log4ts' module. E.g.,

import { Logger, LoggerConfig } from "log4ts";

Structure

Logger uses appenders to display entries. Each appender uses it's own separate layout. You can consider layout as a formatter, that translates log entry object to a string of text, that appender should display or pass somwhere else.

You also can pass formatting function directly to appender, without implementing ILayout interface.

Appenders

Currently there are 2 appender:

ConsoleAppender

ConsoleAppender appends logs directly to your browser js console.

It has no configurable options.

Import with import ConsoleAppender from "log4ts/build/appenders/ConsoleAppender";

DOMAppender

DOMAppender appends logs to some DOM element using innerHTML.

It has 2 constructor parameters:

  1. id (mandatory) - id of the element logs will be attached to.
  2. escape_html (optional, defaults to false) - if set true, logs are html-escaped before being attached.

Import with import DOMAppender from "log4ts/build/appenders/DOMAppender";

Layouts

Currently there are 2 layouts:

BasicLayout

BasicLayout formats log entries as follows: {time} {level} [{tag}] - {message}

It has no configurable options.

Import with import BasicLayout from "log4ts/build/layouts/BasicLayout";

HTMLLayout

HTMLLayout formats time, level, tag and message in span, each with it's own color. You can configure colors passing to constructor either the name of the color scheme or exact color mapping.

Available color themes:

  1. light
  2. dark
  3. solarized

Color mapping fields:

  1. time
  2. level
  3. tag
  4. message

Import with import HTMLLayout from "log4ts/build/layouts/HTMLLayout";

Demo

To run demo page, you can use related grunt task

  1. run npm install to install all dependencies
  2. run grunt demo to compile ts files and run HTTP server
  3. open http://localhost:9000/demo/index.html in browser

log4ts's People

Contributors

koroandr avatar bradseefeld avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.