cute-logger
Simple way to log messages in stdout or other stream.
☁️ Installation
# Using npm npm install --save cute-logger # Using yarn yarn add cute-logger
📋 Example
const Logger = // Set log levelLoggerconfiglevel = 4 // Test defaultsLogger // Don't show dateLoggerconfigdate = falseLogger // Custom typeLoggerconfigmyType = color: 0 255 200 text: "custom" LoggerLoggerLogger // The built-in methods can be accessed like this, too:LoggerLoggerLoggerLogger // Logging objects works nicely too:Logger
❓ Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. 🐛
- For direct and quick help, you can use Codementor. 🚀
📝 Documentation
log(message, type)
Displays debug messages by providing the type.
Usage:
CuteLoggerCuteLogger
The config object can be modified to make this module to act diferently. Defaults are shown:
CuteLoggerconfig = // The error type error: color: 192 57 43 text: "error" level: 1 // The warning type warn: color: 241 196 15 text: "warn " level: 2 // The info type info: color: 52 152 219 text: "info " level: 3 // Display date date: false // Log level level: 4 // Output streams stdout: processstdout stderr: processstderr // The options passed to `util.inspect` inspectOptions: colors: true
Params
- Object
message
: The debug message that should be displayed. Ifmessage
is an object, it will show the inspected object. - String
type
: The message type (e.g. "error", "info" etc). Default is computed ("error"
if the message is anError
) or"info"
if the providedtype
is invalid.
Return
- Object The
CuteLogger
instance.
getDate()
Returns the stringified date. This method can be overrided for a custom date format.
Return
- String The date in HH:mm.ss - DD.MM.YYYY format.
error(message)
Displays debug messages by providing setting the type to "error"
.
Usage:
CuteLogger
Params
- Object
message
: The debug message that should be displayed. Ifmessage
is an object, it will show the inspected object.
Return
- Object The
CuteLogger
instance.
warn(message)
Displays debug messages by providing setting the type to "warn"
.
Usage:
CuteLogger
Params
- Object
message
: The debug message that should be displayed. Ifmessage
is an object, it will show the inspected object.
Return
- Object The
CuteLogger
instance.
info(message)
Displays debug messages by providing setting the type to "info"
.
Usage:
CuteLogger
Params
- Object
message
: The debug message that should be displayed. Ifmessage
is an object, it will show the inspected object.
Return
- Object The
CuteLogger
instance.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💖 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 🚀
-
—I love books! I will remember you after years if you buy me one. 😁 📖
-
—You can make one-time donations via PayPal. I'll probably buy a
coffeetea. 🍵 -
—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
Thanks! ❤️
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
bloggify
bloggify-cli
rucksack