Console-kit

A fast, light weight, minimalist and reliable module to log stuff easly and more understable.

Installation

Use this command to add Console-kit

1  npm i @kawu/console-kit

Usage

TS

1import { ConsoleKit } from "@kawu/console-kit";
2const consoleKit = new ConsoleKit();

JS

1const { ConsoleKit } = require("@kawu/console-kit");
2const consoleKit = new ConsoleKit();

Logging

When logging what's going on in your application is crucial, I have dedicated functions for every situation.

Comments

1consoleKit.comment(CommentOptions);

1// CommentOptions
2
3message: string;
4timestamp: boolean; // Not required

Success

1consoleKit.success(CheckOptions);

1// CheckOptions
2
3message: string;
4timestamp: boolean; // Not required

Info

1consoleKit.info(InfoOptions);

1// InfoOptions
2
3message: string;
4timestamp: boolean; // Not required

Warn

1consoleKit.warn(WarnOptions);

1// WarnOptions
2
3message: string;
4timestamp: boolean; // Not required

Error

1consoleKit.error(ErrorOptions);

1// ErrorOptions
2
3message: string;
4timestamp: boolean; // Not required

Loading

This is kinda usefull to tell that your terminal is doing background stuff.

Start loader

1consoleKit.startLoading(StartLoaderOptions);

1// StartLoaderOptions
2
3message: string;
4timestamp: boolean; // Not required

Stop loader

1consoleKit.stopLoading(StopLoaderOptions);

1// StopLoaderOptions
2
3clearLine: boolean; // Remove the loading line if true

Progress Bar

Like the loading but we know when the loading will finish.

Start progress bar

1consoleKit.startProgress(StartProgressOptions);

1// StartProgressOptions

2
3message: string;

4percentage: number;

5timestamp: boolean; // Not required

Edit the actual progress bar

1consoleKit.editProgress(EditProgressOptions);

1// EditProgressOptions
2
3percentage: number;
4message: string;

End progress bar

1consoleKit.endProgress(EndProgressOptions);

1// EndProgressOptions
2
3clearLine: boolean; // Remove the progress bar line if true

Prompt

If your user need to give you data, then the prompt is a good way to go.

Usage

1consoleKit.prompt(PromptOptions);

1// PromptOptions
2
3message: string;
4character: string; // Not required -- If you wish to replace "?", put your own icon here

Output

1string;

YesNo

It's like prompt but for boolean values.

Usage

1consoleKit.yesno(YesNoOptions);

1// YesNoOptions
2
3message: string;
4defaultValue: boolean; // true = yes | false = no

Output

If the default value is false and the user send for example lol then the output will be false because he didn't put no/n or yes/y.

1boolean;

Select

You have a list and your user have to select an item inside a list, then this will do the job.

1consoleKit.select(SelectOptions);

1values: Array<string>;

2defaultValueIndex: number; // Not required -- Index number of the values array

3selectedText: string; // Not required -- Custom the "[ • ]" (Item selected)

4unselectedText: string; // Not required -- Custom the "[  ]" (Item not selected)

5cleanafter: boolean; // Not required -- Remove the selection of the terminal when user finished