![\"Icon\"](\"https://raw.githubusercontent.com/hack4impact/logger/main/static/images/icon.svg\"/){kind=icon}
\n![\"Version\"/](\"https://img.shields.io/npm/v/@hack4impact/logger?logo=npm&logoColor=FFFFFF&labelColor=000000&label=Version&style=flat-square\")
![\"Downloads\"/](\"https://img.shields.io/npm/dt/@hack4impact/logger?logo=npm&logoColor=FFFFFF&labelColor=000000&label=Downloads&style=flat-square\")
![\"Build\"/](\"https://img.shields.io/github/workflow/status/hack4impact/logger/Node%20CI?logo=github&logoColor=FFFFFF&labelColor=000000&label=Build&style=flat-square\")
![\"Coverage\"/](\"https://img.shields.io/codecov/c/github/hack4impact/logger?style=flat-square&label=Coverage&logo=Codecov&logoColor=FFFFFF&labelColor=000000\")
![\"Code](\"https://img.shields.io/lgtm/grade/javascript/github/hack4impact/logger?logo=lgtm&logoColor=FFFFFF&labelColor=000000&label=Code%20Quality&style=flat-square\")
The 📦 lightweight & ⚡ lightning-fast Logger Utility used by Hack4Impact Projects
\n\nView the website for API documentation and more!
\n\n## Table of Contents\n\n- [Why should you use Hack4Impact's Logger?](#why-should-you-use-hack4impacts-logger)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Website](#website)\n- [Featured Dependents](#featured-dependents)\n- [Contributors](#contributors)\n\n## Why should you use Hack4Impact's Logger?\n\n- 🚀 **NO dependencies, <1.1kB size (zipped)**\n- ✨ TypeScript definitions **built in**\n- 📖 **Thorough** and **detailed** [documentation](https://hack4impact.github.io/logger/docs/classes/logger)\n- ✅ Tested **end-to-end** with Jest\n- 🌟 Code quality **perfected** with linters ([Prettier](https://prettier.io/), [ESLint](https://eslint.org/), [EditorConfig](https://editorconfig.org/), [Markdownlint](https://github.com/DavidAnson/markdownlint)) to reduce **bundle size** and ensure **bug-free code**\n- 💫 Automated [GitHub Workflows](https://github.com/hack4impact/logger/actions?query=workflow%3A%22Node+CI%22) ensure that every change is **high quality** and **functional**\n\n## Installation\n\nUsing [npm](https://www.npmjs.com):\n\n```shell\nnpm install @hack4impact/logger\n```\n\nUsing [yarn](https://yarnpkg.com/):\n\n```shell\nyarn add @hack4impact/logger\n```\n\nYou can browse the package's files on [unpkg](https://unpkg.com/browse/@hack4impact/logger/).\n\n## Usage\n\n```javascript\n// ESM: import { join } from \"path\";\nconst { join } = require(\"path\");\n\n// ESM: import Logger from \"@hack4impact/logger\";\nconst Logger = require(\"@hack4impact/logger\");\n\nconst outputFile = join(__dirname, \"logs.json\");\n\nconst logger = new Logger({ logsPath: outputFile });\n\n// Log \"Hello\" an append a created Log object (w/ message, timestamp, index) to the output file\nlogger.log(\"Hello\");\n\n// Log \"Hello\" and don't append the Log object to the output file\nlogger.log(\"Hello\", { writeToFile: false });\n\n// Log \"WARNING!\" using console.warn and append to the output file\nlogger.warn(\"WARNING!\");\n// ↑ Can also use logger.log(\"WARNING!\", { type: \"warn\" })\n\n// Log \"ERROR!\" using console.error and append the created Log object (w/ extra as well) to the output file\nlogger.error(\"ERROR!\", { extra: \"Not logged but written to file\" });\n\n// Log a success message using the static method 'success'\nLogger.success(\"It works!\");\n\n// The list goes on...\n\n// Refer to the website for a comprehensive list of all methods with examples\n```\n\n## Website\n\n[](https://hack4impact.github.io/logger/)\n\n**[The website contains all API documentation and information about this package.](https://hack4impact.github.io/logger/)**\n\n## Featured Dependents\n\nIf your project uses this package, you can add it to this list by submitting a PR [here](https://github.com/hack4impact/logger/pulls).\n\n| Owner | Repository Information |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n|![](\"https://raw.githubusercontent.com/hack4impact/logger/main/static/images/hack4impact-icon.png\"/){kind=icon}
[Hack4Impact](https://github.com/hack4impact)
| [](https://github.com/hack4impact/feedback-survey-automation) |\n|
[Hack4Impact Calpoly](https://github.com/hack4impact-calpoly)
| [](https://github.com/hack4impact-calpoly/happy-hats) |\n\n## Contributors\n\nProject Contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n![\"\"/](\"https://avatars.githubusercontent.com/u/30784592?v=4?s=100\") Yash Totale 💻 🤔 📖 | \n