Skip to content

Introducing Itivruttah!

Itivruttah

Note

This docs site is under construction, so there are a lot of things missing. More docs will be added and existing docs will be improved before releasing Itivruttah.

💿 Installation

1
npm install --save itivruttah

or if you are using yarn then,

1
yarn add itivruttah

🏍 Quick Start

After installing Itivruttah using the above commands, you can use it in the following way:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Require the itivruttah logging system
const itivruttah = require('itivruttah');

// Create a new instance of the Logger
let logger = new itivruttah.createNewLogger({
    // Optional configuration
});


// Example to log a critical message
logger.logCritical("This is a critical message.");

// Example to log a warning message
logger.logWarning("This is an example warning message.");

// Example to log a verbose message, which will be only shown
// When there is "--verbose" flag is found in the command-line arguments
logger.logVerbose("This is a message that should be useful to devs.");

// Example to log an OK message
logger.logOK("This is a message that is not an info, but says OK!");

// Example to log an informational message
logger.logInfo("This is an example of an informational statement.");

// Example to log a success message
logger.logSuccess("This is a success message, that makes everyone happy.");

To know what optional configuration options can be passed and how you can dynamically change the theme (layout of the log message) and styles, checkout the customization page.

🏅 Highlights

  • Dynamically change the log message statement
  • Writing log to a file with header text support
  • Ability to create custom log messages
  • Easy to use and open-source (MIT)

More will be added as I get feature requests from you.

🤔 Why "Itivruttah"?

🎉 Support Itivruttah