Hack4Impact Logger

       

The 📦 lightweight & ⚡ lightning-fast Logger Utility used by Hack4Impact Projects

View the website for API documentation and more!

Table of Contents

• Why should you use Hack4Impact's Logger?
• Installation
• Usage
• Website
• Featured Dependents
• Contributors

Why should you use Hack4Impact's Logger?

• 🚀 NO dependencies, <1.1kB size (zipped)
• ✨ TypeScript definitions built in
• 📖 Thorough and detailed documentation
• ✅ Tested end-to-end with Jest
• 🌟 Code quality perfected with linters (Prettier, ESLint, EditorConfig, Markdownlint) to reduce bundle size and ensure bug-free code
• 💫 Automated GitHub Workflows ensure that every change is high quality and functional

Installation

Using npm:

npm install @hack4impact/logger

Using yarn:

yarn add @hack4impact/logger

You can browse the package's files on unpkg.

Usage

// ESM: import { join } from "path";
const { join } = require("path");

// ESM: import Logger from "@hack4impact/logger";
const Logger = require("@hack4impact/logger");

const outputFile = join(__dirname, "logs.json");

const logger = new Logger({ logsPath: outputFile });

// Log "Hello" an append a created Log object (w/ message, timestamp, index) to the output file
logger.log("Hello");

// Log "Hello" and don't append the Log object to the output file
logger.log("Hello", { writeToFile: false });

// Log "WARNING!" using console.warn and append to the output file
logger.warn("WARNING!");
// ↑ Can also use logger.log("WARNING!", { type: "warn" })

// Log "ERROR!" using console.error and append the created Log object (w/ extra as well) to the output file
logger.error("ERROR!", { extra: "Not logged but written to file" });

// Log a success message using the static method 'success'
Logger.success("It works!");

// The list goes on...

// Refer to the website for a comprehensive list of all methods with examples

Website

The website contains all API documentation and information about this package.

Featured Dependents

If your project uses this package, you can add it to this list by submitting a PR here.

Owner	Repository Information
Hack4Impact
Hack4Impact Calpoly

Contributors

Project Contributors (emoji key):

Yash Totale 💻 🤔 📖

This project follows the all-contributors specification. Contributions of any kind welcome!