log2discord v1.0.3

log2discord

Log2discord is a logging module that logs events and errors to Discord.

Install

# with npm
npm install log2discord

Configuration

Log2discord requires the use of Discord webhooks. Instructions on how to obtain a webhook url can be found here.

Example configuration

import log2discord from 'log2discord';
const logger = new log2discord.Logger({
    webhook: "https://discord.com/api/webhooks/<id>/<token>", // Discord webhook token
    icon: "https://linktoyourappicon.com/icon.png", // Will be used as profile photo
    name: "YourApp",
    pid: true,
    host: true,
    dateTime: {
        timeZone: "America/New_York",
        locale: "en-US"
    }
});

Available configuration options

Usage

Error

logger.error({
    title: "Error message title",
    message: "This is an error message 🛑",
    error: Error("Example error") // Can also be an error callback
})

Warning

logger.warn({
    title: "Warning message title",
    message: "This is a warning message 🚧",
})

Debug

logger.debug({
    title: "Debug message title",
    message: "This is a debug message 🐛",
    json: {
        valid: "JSON object"
    }
})

Info

logger.info({
    title: "Info message title",
    message: "This is an info message 🔤",
})

Custom

logger.custom({
    type: "CUSTOM",
    color: 123,
    title: "Custom message title",
    message: "This is a custom message 🦄",
    json: {
        valid: "JSON object"
    }
})

Available logging options