# hyperz-nodelogger

> A node logger desinged to replicate the boot file in most of my github repos

Latest version **3.7.3** (published 2022-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install hyperz-nodelogger
pnpm add hyperz-nodelogger
yarn add hyperz-nodelogger
bun add hyperz-nodelogger
```

## 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 | 3.7.3 |
| Published | 2022-02-20 |
| First published | 2021-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Hyperz#0001 |
| Maintainers | hyperz |
| Keywords | Hyperz, Hyperz, Development, Hyperz, Node, Logger, Node, Logger, Node, Logger |

## Links

- npm: https://www.npmjs.com/package/hyperz-nodelogger
- Repository: https://github.com/Itz-Hyperz/Hyperz-NodeLogger
- Homepage: https://github.com/Itz-Hyperz/Hyperz-NodeLogger#readme
- Issues: https://github.com/Itz-Hyperz/Hyperz-NodeLogger/issues
- npm.io page: https://npm.io/package/hyperz-nodelogger

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [carden](https://npm.io/package/carden.md) ^4.0.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0

## 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

- 3.7.3 (latest) — 2022-02-20
- 3.7.2 — 2021-08-18
- 3.7.1 — 2021-07-21
- 3.7.0 — 2021-07-21
- 3.6.3 — 2021-07-21
- 3.6.2 — 2021-07-21
- 3.6.1 — 2021-07-21
- 3.6.0 — 2021-07-21
- 3.5.1 — 2021-07-21
- 3.5.0 — 2021-07-21
- 3.0.2 — 2021-07-20
- 3.0.1 — 2021-07-20
- 3.0.0 — 2021-07-20
- 2.1.6 — 2021-07-20
- 2.0.1 — 2021-07-20
- … 5 more at https://npm.io/package/hyperz-nodelogger/versions

## README

# Hyperz-NodeLogger
A node logger using multiple external npm modules to allow you to build your own stylish console logger.

---

## Support

* [Discord](https://hyperz.net/discord)

* [Website](https://hyperz.net/)

---

## Installation

`npm i hyperz-nodelogger@latest`

---

## Using The Logger

The nodelogger function offers a fair amount of customization.

| Entry        | Type | Definition | 
|----------------|---------------|---------------|
| #1   | STRING  | The header, this is the top of the embed
| #2   | STRING  | The width of the header
| #3   | STRING  | The color of the ASCII text for the header (must work with npm chalk)
| #4   | STRING  | The body section of the logger, doesn't support color yet
| #5   | STRING  | The background color of the logger, can be a color HEX, or disable it by setting to "disabled"
| #6   | STRING  | The border around the logger box, can be a color hex
| #7   | STRING  | The [border style](#border-styles) around the logger module
| #8   | BOOLEAN  | Make the header border match the body border

---

## Border Styles

- single
- classic
- double
- round
- none

---

## Code Example

```js
const nodelogger = require('hyperz-nodelogger')

client.on("ready", () => {
    const logger = new nodelogger()
    // Entries: header, headerWidth, headerColor, body, backgroundColor, borderColor, borderStyle, fullBorders
    logger.hypelogger(`HDClient`, '500', 'green', `What a cool feature for a node module!\n\nPretty dank ngl`, 'disabled', 'green', 'single', false)
});
```

![](https://cdn.hyperz.dev/zqo6whvs.png)

---

## What are the dependencies?

[Figlet](https://www.npmjs.com/package/figlet)

[Carden](https://www.npmjs.com/package/carden/v/3.0.0)

[Chalk](https://www.npmjs.com/package/chalk)

[Axios](https://www.npmjs.com/package/axios)

---

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