# sk-console

> The package contains nicely formatted console log functions

Latest version **1.0.1** (published 2023-08-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install sk-console
pnpm add sk-console
yarn add sk-console
bun add sk-console
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-08-04 |
| First published | 2023-08-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 0 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sumit Verma |
| Maintainers | theskv0 |
| Keywords | log, console, nodejs-console |

## Links

- npm: https://www.npmjs.com/package/sk-console
- npm.io page: https://npm.io/package/sk-console

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-08-04
- 1.0.0 — 2023-08-04

## README

<!-- START -->
<br>
<br>
<div align="center">
  <a href="https://sumitkumarverma.com">
    <img src="https://sumitkumarverma.com/images/logo.svg" alt="Logo" width="100">
  </a>
  <h3 align="center">Package for pretty console logs</h3>
  <br>
  <p align="center">
    Developed by <a href="https://sumitkumarverma.com">Sumit Verma</a>
    <br />
    <br />
  </p>
</div>


<!-- ABOUT THE PACKAGE -->
### About The Package

The package contains nicely formatted `console log` functions
<br>
It can be used with `ES5` and upper versions as well as with `Typescript`.

<br>

<!-- GETTING STARTED -->

### Installation

_Follow the steps to install and configure the package._

  ```sh
  npm install sk-console
  ```
<br>

<!-- USAGE EXAMPLES -->
### Usage

#### Import the package
If you use require for importing.
```js
  const SkConsole = require("sk-console").default;
```
If you use import for importing.
```js
  import SkConsole from "sk-console";
```

### Log
```js
  SKConsole.log('Log');
```
Output
<br>
<span style="color: white;">&nbsp;◾ Log&nbsp;</span>
<br>
<br>


### Log Header
```js
  SKConsole.logHeader('Log Header');
```
Output
<br>
<span style="color: black; background: white;">&nbsp;◾ Log Header&nbsp;</span>
<br>
<br>


### Info
```js
  SKConsole.info('Info');
```
Output
<br>
<span style="color: cyan;">&nbsp;➡ Info&nbsp;</span>
<br>
<br>


### Info Header
```js
  SKConsole.infoHeader('Info Header');
```
Output
<br>
<span style="color: black; background: cyan;">&nbsp;➡ Info Header&nbsp;</span>
<br>
<br>


### Success
```js
  SKConsole.success('Success');
```
Output
<br>
<span style="color: green;">&nbsp;✔ Success&nbsp;</span>
<br>
<br>


### Success Header
```js
  SKConsole.successHeader('Success');
```
Output
<br>
<span style="color: white; background: green">&nbsp;✔ Success Header&nbsp;</span>
<br>
<br>


### Error
```js
  SKConsole.error('Error');
```
Output
<br>
<span style="color: red;">&nbsp;✖ Error&nbsp;</span>
<br>
<br>


### Error Header
```js
  SKConsole.errorHeader('Error');
```
Output
<br>
<span style="color: white; background: red">&nbsp;✖ Error Header&nbsp;</span>
<br>
<br>


### Warning
```js
  SKConsole.warning('Warning');
```
Output
<br>
<span style="color: yellow;">&nbsp;❇ Warning&nbsp;</span>
<br>
<br>


### Warning Header
```js
  SKConsole.warningHeader('Warning');
```
Output
<br>
<span style="color: black; background: yellow">&nbsp;❇ Warning Header&nbsp;</span>
<br>
<br>

---
_Source: https://npm.io/package/sk-console · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
