https://github.com/voiddevsorg/node-console

https://github.com/voiddevsorg/node-console

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/voiddevsorg/node-console
• Owner: VoidDevsorg
• License: mit
• Created: 2023-01-26T00:33:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-26T00:34:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-24T10:18:07.226Z (9 months ago)
• Language: TypeScript
• Size: 10.7 KB
• Stars: 3
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [@voidpkg/console](https://npmjs.com/package/@voidpkg/console)

[Do you need my help? Visit our Discord server.](https://voiddevs.org/discord)

![NPM Downloads](https://img.shields.io/npm/dm/@voidpkg/console?style=for-the-badge)

![License](https://img.shields.io/npm/l/@voidpkg/console?style=for-the-badge)

### Installation

```bash

npm i @voidpkg/console --save

# or

yarn add @voidpkg/console

```

### Images

![Foreground](https://i.imgur.com/6SwTjOh.png)

![Background](https://i.imgur.com/jnQflH9.png)




### Importing

```js

import { Consoler } from '@voidpkg/console'; // ESM

const { Consoler } = require('@voidpkg/console'); // CJS

new Consoler({

    timestamp: false, // (default: false)

    variant: 'background', // or 'foreground' (default: 'foreground')

    title: "Global Title" // (default: 'SUCCESS', 'ERROR', 'WARNING', 'INFO', 'LOADING')

});

```




# Usage

```js

// Basic Usage

console.success('Successfully passed!');

console.error('An error occurred!');

console.warn('This is a warning!');

console.info('This is an info message!');

// With Custom Style

console.success('This is a {b}bold{reset}{c.green} message!{r}', { title: 'Custom Title' });

console.error('This is a {bold}bold and {italic}italic{reset}{c.red} message!{r}', { title: 'Custom Title' });

console.warn('This is a {i}italic{r}{c.yellow}  and {b}bold{r}{c.yellow} message!{r}', { title: 'Custom Title' });

console.info('This is a {i}italic{r}{c.blue}, {b}bold{r}{c.blue} and {italic}{bold}both{reset}{c.blue} message!{r}', { title: 'Custom Title' });

console.info('The time is {tt}!{r}', { title: 'Custom Title' });

console.success('This is a {c.red}red{r}{c.green} message!{r}', { title: 'Custom Title' });

console.error('This is a {c.green}green{reset}{c.red} message and a timestamp!{r}', { title: 'Custom Title', timestamp: true });

// Loading

setTimeout(() => {

    console.loading(10 * 1000, '{indicator} Loading...', () => {

        console.success('Loading finished!');

    }, { title: 'Custom Title' });

}, 10000);

```




# Styling

```js

// Colors

{c.red}Red{r}

{c.green}Green{r}

{c.yellow}Yellow{r}

{c.blue}Blue{r}

{c.magenta}Magenta{r}

{c.cyan}Cyan{r}

{c.white}White{r}

{c.black}Black{r}

{c.gray}Gray{r}

// Styles

{b}Bold{r}

{i}Italic{r}

{u}Underline{r}

{s}Strikethrough{r}

// or

{bold}Bold{reset}

{italic}Italic{reset}

{underline}Underline{reset}

{strikethrough}Strikethrough{reset}

// Timestamp

{tt}Timestamp{r}

// or

{timestamp}Timestamp{reset}

// Indicators (Loading)

{indicator}Indicator{r}

```




---

Developed with ❤️ by Void Development