Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 3.2 KB

README.md

File metadata and controls

61 lines (47 loc) · 3.2 KB

Euphoria Logger (euphoria-logger)

NPM Version GitHub npm npm bundle size node-current Made with Love

Description

Euphoria Logger is a versatile and powerful logging library for Node.js applications. It provides a comprehensive set of features to handle logging in various environments, including:

  • Custom Log Levels: Define and use custom log levels to suit your application's needs.
  • Console Logging with Native Colors and Custom Formats: Log messages to the console with customizable node console colors and formats for better readability.
  • File Logging with Rotation, Compression and Buffering: Log messages to files with options for file rotation based on a set size, buffering to improve overall performance and reduce requests, configurable log level and the ability to specify the logged types.
  • Logging to Webhooks: Send log messages to popular social platforms like Discord, Guilded, Telegram, and Slack using webhooks.
  • Multiple Logger Instances: Create and manage multiple logger instances within a single project, each with its own configuration.

Whether you need to log messages to the console, files, or webhooks, Euphoria Logger provides a flexible and efficient solution to meet your logging requirements.

Table of Contents

Installation

You can install euphoria-logger using your preferred package manager:

Package Manager Command
npm - NPM npm install euphoria-logger
pnpm - PNPM pnpm install euphoria-logger
yarn - Yarn yarn add euphoria-logger
bun - Bun bun add euphoria-logger

Usage

The logger supports ES5 and ES6, therefore there are 2 ways the package can be imported depending on the project structure.

ES5

const { Logger } = require("euphoria-logger");
const logger = new Logger();

ES6

import { Logger } from "euphoria-logger";
const logger = new Logger();

Documentation

To view the documentation, check out the docs folder.

Contributing

License

This package is licensed under the AGPL-3.0 license. See the LICENSE file for more information.