DiscordWebhookLogger

DiscordWebhookLogger is a TypeScript class for sending structured log messages to Discord via webhooks. It supports customizable log levels, message formatting, and multiple webhook URLs.

Installation

npm i discord-webhook-logger

Usage

Basic Usage

import { DiscordWebhookLogger } from "discord-webhook-logger";

const logger = new DiscordWebhookLogger({
  webhookUrls: [
    "https://discord.com/api/webhooks/your-webhook-id/your-webhook-token",
  ],
});

logger.info("This is an info message!");
logger.error("An error occurred!");

Constructor

new DiscordWebhookLogger({
    webhookUrls,
    format?,
}: {
    webhookUrls: string[];
    format?: (input: FormatterInput) => string;
})

Parameters

• webhookUrls (required): An array of Discord webhook URLs to send log messages to.
• format (optional): A function to format messages before sending. Defaults to defaultFormatter.

Methods

log({ level, message, discordTargetId?, additionalData? }: LogMessage): void

Logs a message with the specified log level and additional data.

logger.log({
  level: "info",
  message: "This is a custom log message.",
  discordTargetId: "123456789",
  additionalData: { key: "value" },
});

Common Log Levels

• error(message: string): void
• warn(message: string): void
• info(message: string): void
• http(message: string): void
• verbose(message: string): void
• debug(message: string): void
• silly(message: string): void

logger.error("An error occurred!");
logger.debug("Debugging information.");

Customization

Custom Message Formatting

Provide a custom formatter function to control how messages are formatted.

const customFormatter = (input: FormatterInput) =>
  `[${input.level}] ${input.message}`;

const logger = new DiscordWebhookLogger({
  webhookUrls: [
    "https://discord.com/api/webhooks/your-webhook-id/your-webhook-token",
  ],
  format: customFormatter,
});

logger.info("This message is formatted with a custom formatter!");

Requirements

• Node.js version 18 or higher.
• Discord webhook URLs.

License

This code is provided under the MIT License. Feel free to use, modify, and distribute it as needed.

Contribution

Feel free to submit issues or contribute improvements to this class.