# emoji-logger > Logging library based on flat colors and Emoji. Latest version **1.0.16** (published 2025-02-13) · MIT license · 0 weekly downloads ## Install ```sh npm install emoji-logger pnpm add emoji-logger yarn add emoji-logger bun add emoji-logger ``` ## Health **Score 25/100 (F)** — status: maintenance-mode. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.16 | | Published | 2025-02-13 | | First published | 2015-12-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 10.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | Ionică Bizău | | Maintainers | ionicabizau | | Keywords | emoji, logging, logger, terminal | ## Links - npm: https://www.npmjs.com/package/emoji-logger - Repository: https://github.com/IonicaBizau/emoji-logger - Homepage: https://github.com/IonicaBizau/emoji-logger#readme - Issues: https://github.com/IonicaBizau/emoji-logger/issues - npm.io page: https://npm.io/package/emoji-logger ## Dependencies (7) - [ul](https://npm.io/package/ul.md) ^5.2.0 - [err](https://npm.io/package/err.md) ^1.1.0 - [deffy](https://npm.io/package/deffy.md) ^2.2.2 - [emojic](https://npm.io/package/emojic.md) ^1.1.0 - [is-win](https://npm.io/package/is-win.md) ^1.0.4 - [indento](https://npm.io/package/indento.md) ^1.1.0 - [color-it](https://npm.io/package/color-it.md) ^1.2.0 ## Alternatives - [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads - [log](https://npm.io/package/log.md) — 1.3M weekly downloads - [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads - [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads - [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads ## Recent versions - 1.0.16 (latest) — 2025-02-13 - 1.0.15 — 2020-08-09 - 1.0.14 — 2019-01-03 - 1.0.13 — 2017-12-24 - 1.0.12 — 2017-12-24 - 1.0.11 — 2017-09-08 - 1.0.10 — 2017-06-14 - 1.0.9 — 2017-06-14 - 1.0.8 — 2017-03-23 - 1.0.7 — 2017-03-20 - 1.0.6 — 2017-01-02 - 1.0.5 — 2016-10-11 - 1.0.4 — 2016-10-10 - 1.0.3 — 2016-05-25 - 1.0.2 — 2016-04-25 - … 2 more at https://npm.io/package/emoji-logger/versions ## README # emoji-logger [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/emoji-logger.svg)](https://www.npmjs.com/package/emoji-logger) [![Downloads](https://img.shields.io/npm/dt/emoji-logger.svg)](https://www.npmjs.com/package/emoji-logger) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) Buy Me A Coffee > Logging library based on flat colors and Emoji. [![emoji-logger](http://i.imgur.com/rp8lm00.png)](#) ## :cloud: Installation ```sh # Using npm npm install --save emoji-logger # Using yarn yarn add emoji-logger ``` ## :clipboard: Example ```js const log = require("emoji-logger"); // Info message log("The default type is info."); log("Show another info message", "info"); log("A success message.", "success"); log("Some nasty error", "error"); log("Warning! Do not touch!", "warn"); // Add a new type log.add("fail", "disappointed", "pomegranateBg", 1); // Show the fail message log("Something went wrong.", "fail"); ``` ## :question: Get Help There are few ways to get help: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation ### `emojiLogger(msg, type, override)` Logs the specified message. #### Params - **String** `msg`: The message to log. - **String** `type`: The message type (default: `"info"`). - **Object** `override`: An object to override the type object fields. ### `log(msg, type, override)` Writes the input message having the type object. #### Params - **String** `msg`: The message to log. - **Object** `type`: The type object. - **Object** `override`: An object to override the type object fields. ### `add(type, icon, color, indent, stream, boolean)` Adds a new logging type. #### Params - **String** `type`: The log type as string or an object containing: - **String** `icon`: The emoji icon name interpreted by [`emojic`](https://github.com/IonicaBizau/emojic). - **String** `color`: The color name (interpreted by [`color-it`](https://github.com/IonicaBizau/node-color-it)). - **Number** `indent`: The indent width. - **Stream** `stream`: The stream where the messages of this type will be written (default: `process.stdout`). - **displayEmoji** `boolean`: If `false`, emojis will not be added in the message. By default, it's `false` on Windows systems and `true` otherwise. #### Return - **Object** The type object. ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: Support my projects I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: - Starring and sharing the projects you like :rocket: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` ![](https://i.imgur.com/z6OQI95.png) Thanks! :heart: ## :dizzy: Where is this library used? If you are using this library in one of your projects, add it in this list. :sparkles: - `bloggify-tools` - `emojer-cli` - `emspect` - `gh-notifier` - `github-emojify` - `namly` - `packy` - `pull-from-source` - `rucksack.js` - `tester` - `tester-init` ## :scroll: License [MIT][license] © [Ionică Bizău][website] [license]: /LICENSE [website]: https://ionicabizau.net [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW --- _Source: https://npm.io/package/emoji-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._