Skip to content
This repository has been archived by the owner on Apr 13, 2024. It is now read-only.
/ Loggaby Public archive

๐Ÿ“ A simple, lightweight and customizable logger.

License

Notifications You must be signed in to change notification settings

TorchedArchive/Loggaby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

62 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Loggaby

๐Ÿ“ A simple, lightweight and customizable logger.

GitHub license GitHub stars
Loggaby is the simple, lightweight and minimal logger.
It has 1 goal and strives for it well: Posting nice looking logs to your terminal (or wherever you want, see the examples for details)

Preview
How the default log format looks.

PS: It's also customizable (highly so)! From how it looks, to the log destination.
Preview

Table of Contents

Install

npm install loggaby

Or with Yarn:
yarn add loggaby

Examples

Provided Here.

Documentation

new Loggaby(options)

The Loggaby constructor, which creates a new Loggaby instance.

  • options {Object}
    • debug {Boolean | String} Whether to print debug messages. Can be a boolean or 'auto'. (Default: true)
    • format {String} Format for how logs should look (Default: '{grey}{time}{reset} {level} > ')
    • levels {Object[]} Additional custom levels to provide.
      • name {String} Name of the level that appears in the logs.
      • color {String} Color of the level name. Accepted values are a hex value or named colors.
      • debug {Boolean} Whether this level will be hidden when options.debug is false.
      • fatal {Boolean} Whether to make the level name and message bold and underline (to be noticeable).
      • call {String} Name of the function to use this level.
    • transports {Object[]} (An array of objects or specifically transport instances) What transports to log to. An example is provided above. (Default: [TerminalTransport])

Default Levels

debug, log, warn, error and fatal
You can log with Loggaby.<Level>().

License

Loggaby is licensed under the MIT license.
Read here for more info.


A Rosettea project.