/consoli

A fancy console with the capability of use in production mode.

Primary LanguageTypeScriptMIT LicenseMIT

Consoli js

npm GitHub issues npm GitHub contributors GitHub license PRs Welcome GitHub Repo stars


consoli


Consoli is a new simple and fancy logger that help you even in production mode.

Features

  • β˜‘ Typescript.
  • ⭐️ tag property of logs.
  • πŸ‘ see logs even in production.
  • β˜„οΈ Colorize tags.

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies:

npm i consolijs

🚨This package is standalone and have no any other dependacy.🚨

Usage

consoliClient.ts

import { Consoli } from "consoli";

export const consoli = new Consoli({

  nodeEnv: import.meta.env.MODE,
  secretKey: import.meta.env.VITE_CONSOLI,
  defaultDeveloperMode: ["SUCCESS"],
  tags: [{ displayName: "myTag", color: "#9f00a1" }],

});

main.ts

import { consoli } from "./consoliClient";

window.consoli = consoli; // for global usage
window.verbose = async () => {
  await consoli.verbose();
};

consoli.log("it a log consoli πŸ’ŽπŸ’Ž");
consoli.warn("it a warn consoli πŸ”ΆπŸ”Ά");
consoli.error("it a error consoli 🧯🧯");
consoli.success("it a success consoli πŸ”‹πŸ”‹");
consoli.tags?.myTag("it a my tag consoli πŸ‡πŸ‡");

global.d.ts

interface Window {
  verbose: () => Promise<void>;
  consoli: Consoli<"myTag">;
}

Usage in client

Press F12 , go to consol tab and write:

verbose()

And you see :

consoli consoli

Avalilible Params

property type description
onMessageCallback void callback after get the message.
defaultDeveloperMode SUCCESS,INFO,WARN,ERROR default enabled options for developer mode.
tags Array of Tags .

LICENSE

MIT