@nidrux/log.js

Log.js

Table of Contents

1. Installation
2. Usage 2.1 No Webhooks 2.2 Setting options later 2.3 Tracing
3. Options

Installation

npm i @nidrux/log.js

Usage

//Without any configuration
const LoggingManager = new LoggingManager();
LoggingManager.Log(LoggingManager.levels.warn, "oh no a warning");


// Output: [November 29th 2022, 7:14:49 pm] WARN oh no a warning

//With configuration
let options = {
    enableColors: true,
    dateFormatting: "hh:mm:ss",
    webhooks: {
        hooks: ["your hook here"],
        onEvents: ["error", "fatal"], //["info", "warn", "error" , "fatal"]
    }
}
const LoggingManager = new LoggingManager(options);
LoggingManager.Log(LoggingManager.levels.warn, "oh no a warning");


// Output: [07:16:57] WARN oh no a warning

No webhooks?

Don't want webhooks enabled? Just remove the webhook option!

Setting options later?

Setting options is something you can do after initializing the LoggingManager or you can provide them directly as shown before. You could use the LoggingManager instance to populate your onEvents array with the correct levels. This isn't needed as you can also use strings but make sure that everything is spelled correctly. Otherwise it won't send the logs to the webhook

//Setting options later somewhere.
const LoggingManager = new LoggingManager();
LoggingManager.Log(LoggingManager.levels.warn, "oh no a warning");

// Output: [November 29th 2022, 7:29:32 pm] WARN oh no a warning

/*
Some other code
*/
let options = {
    enableColors: true,
    dateFormatting: "hh:mm:ss",
    webhooks: {
        hooks: ["your hook here"],
        onEvents: [LoggingManager.levels.fatal, LoggingManager.levels.error], //["info", "warn", "error" , "fatal"]
    }
}

LoggingManager.config = options
LoggingManager.Log(LoggingManager.levels.warn, "oh no a second warning");

// Output: [07:29:32] WARN oh no a second warning

Tracing

You can trace where errors originate from by setting the trace option to true. This is by default set to false. log.js will automaticly detect error objects (when provided) to match the stack trace from that error. otherwise it will generate a trace from where that log originates from.

//With configuration
let options = {
    enableColors: true,
    dateFormatting: "hh:mm:ss",
    trace: true
}
const LoggingManager = new LoggingManager(options);

let error = new Error();

LoggingManager.Log(LoggingManager.levels.error, error);


// Output: [07:16:57] (test.js:0:0) ERROR Error object

Options

let options = {
    enableColors: true,
    dateFormatting: "DD/MM/YYYY - hh:mm:ss",
    webhooks: {
        hooks: ["your hook here"],
        onEvents: ["error", "fatal"], //["info", "warn", "error" , "fatal"]
    },
    trace: true
}

Key	Value	description
enableColors	Boolean	default is set to false
dateFormatting	date format string	default string is set to "DD/MM/YYYY - hh:mm:ss"
trace	Boolean	view where the error originates from
webhooks	Object	needs to include hooks and onEvents!
hooks	array	valid webhooks.
onEvents	array	["info", "warn", "error" , "fatal"]