# sloggin

> A simpler way for logging in Node.JS

Latest version **1.0.1** (published 2019-03-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install sloggin
pnpm add sloggin
yarn add sloggin
bun add sloggin
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-03-03 |
| First published | 2019-03-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | olivercordingl1 |
| Maintainers | olivercordingl1 |

## Links

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

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2

## Recent versions

- 1.0.1 (latest) — 2019-03-03
- 1.0.0 — 2019-03-03

## README

# sloggin
Sloggin is one of the easiest ways to log a Node program.

### Step 1:
In the terminal, type `npm i -S sloggin`
### Step 2:
At the top of your root Javascript file, write 
```Javascript
const Logger = require('sloggin').Logger;
const logger = new Logger(__dirname);
```
### Step 3:
To write something in the logs, you need to call one of 5 functions; `logger.info(string, show_in_terminal (default = true)`,  `logger.success(string, show_in_terminal (default = true)`, `logger.warning(string, show_in_terminal (default = true)`, `logger.error(string, show_in_terminal (default = true)` or `logger.fatal(string, error, show_in_terminal(default = true)`. Info prints out plain text into the terminal, with the prefix `[*]`,  success prints out green text into the terminal with the prefix `[•]`, warning prints out yellow text into the terminal with the prefix `[!]`, error prints out red text into the terminal with the prefix `[#]` and fatal prints out bold, red text into the terminal with the prefix `[X]`.

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