Giter Club home page Giter Club logo

dependency-logs's Introduction

๐Ÿ“ฆ dependency-logs // @thefirstspine/logs

Javascript and Typescript service to deliver unified logs. Works with Winstonjs.

Each log has fixed parts that are separated with a tabulation character \t:

{timestamp}\t{level}\t{fullMessage}

fullMessage is a JSON object that has two properties:

  • message that is the main message of the log
  • data that is some data about the log (context for instance).

Install

npm i @thefirstspine/logs@latest

Documentation

LogsService

Main service to handle the logs in the TFS Platform.

info

Log an information message. An information is has only a purpose for debugging.

Synopsis: info(message: string, data?: any): void

Params:

  • message: string The message to log.
  • data?: any The data about the log (context for instance).

warning

Log a warning. A warning is an unexpected behavior that occurs in the platform, but handled properly.

Synopsis: warning(message: string, data?: any): void

Params:

  • message: string The message to log.
  • data?: any The data about the log (context for instance).

error

Log an error. An error should be treated immediatly because this is an unexpected and not handled behavior.

Synopsis: error(message: string, data?: any): void

Params:

  • message: string The message to log.
  • data?: any The data about the log (context for instance).

How to use

Build

npm run build

Lint

npm run lint

Publish on NPM

npm publish

License

TFS Platform is NOT licensed. You are free to download, view, run the repository. You are NOT allowed to redistribute this project for both commercial and non-commercial use. Deal with it.

dependency-logs's People

Contributors

thefirstspine avatar teddygandon avatar dependabot[bot] avatar

Watchers

James Cloos avatar  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.