margojs v1.0.1

Margo.js

Local logging library for Discord.js bots. Designed for KaiBot and Quentin Discord Applications.

Turn this:

Hey this needs to be logged!

Into this:

[11:44:55PM] [<location>/INFO]: Hey this needs to be logged!

Full documentation can be found here

JavaScript Usage

Create logger

We need to create a new logger with a directory to put the logs.

const Margo = require('margojs');
const logger = new Margo.logger('./logs');

Error handling

Margo can now log uncaught exceptions and rejections.

const exception = new Margo.exceptions(logger);
const rejection = new Margo.rejections(logger);

After this we need to tell Margo to start handling error events.

exception.handle();
rejection.handle();

These can be turned off at anytime using the unhandle() method.

Logging levels

Margo has 5 logging levels. Each type of level has its own method. | Name | Example | Usage | ---------| ----------------| ----------- | debug | logger.debug(message) | 'message' : string of the message to be logged. | error | logger.error(message) | 'message' : string of the message to be logged. | info | logger.info(message) | 'message' : string of the message to be logged. | log | logger.log(type, message) | 'type' : custom level type string, 'message' : string of the message to be logged. | warn | logger.warn(message) | 'message' : string of the message to be logged.

Events

Margo will emit events for each logging level.

logger.on('error', (err) => {
    // Emits every time 'logger.error()' is called.
})