https://github.com/itz-hyperz/hyperz-nodelogger
A node logger using multiple external npm modules to allow you to build your own stylish console logger. This is used in many of my current github repositories simply because it is unique and stylish and shows you have some real professional style under your sleeve.
https://github.com/itz-hyperz/hyperz-nodelogger
app node-js node-module nodejs template
Last synced: 7 months ago
JSON representation
A node logger using multiple external npm modules to allow you to build your own stylish console logger. This is used in many of my current github repositories simply because it is unique and stylish and shows you have some real professional style under your sleeve.
- Host: GitHub
- URL: https://github.com/itz-hyperz/hyperz-nodelogger
- Owner: Itz-Hyperz
- License: mit
- Created: 2021-07-20T17:53:03.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-02-20T16:20:28.000Z (over 4 years ago)
- Last Synced: 2025-07-02T17:10:04.435Z (11 months ago)
- Topics: app, node-js, node-module, nodejs, template
- Language: JavaScript
- Homepage: https://npmjs.org/package/hyperz-nodelogger
- Size: 48.8 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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)
});
```
---
## 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)
---