https://github.com/karbonitekream/unklogger
A simple and colorful logger for Node
https://github.com/karbonitekream/unklogger
extensions hooks javascript logging node
Last synced: about 1 year ago
JSON representation
A simple and colorful logger for Node
- Host: GitHub
- URL: https://github.com/karbonitekream/unklogger
- Owner: KarboniteKream
- License: mit
- Created: 2017-03-10T17:42:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T01:21:00.000Z (over 1 year ago)
- Last Synced: 2025-04-10T07:18:04.628Z (about 1 year ago)
- Topics: extensions, hooks, javascript, logging, node
- Language: JavaScript
- Homepage:
- Size: 140 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unklogger
A simple and colorful logger for Node.js.
## Installation
```bash
npm install [--save] unklogger
```
## Usage
```javascript
import unklogger from "unklogger";
unklogger.log("What's up?");
// 2017-03-10 18:55:05 | What's up?
unklogger.success("Looking good!");
// 2017-03-10 18:55:15 | Looking good!
unklogger.error("Server #1", "OH NO!");
// 2017-03-10 19:00:00 | [Server #1] OH NO!
unklogger.warn("Response", "OK", { foo: "0", bar: "1" }, [0, 1, 2]);
// 2017-03-10 19:11:07 | [Response] OK { foo: "0", bar: "1" } [0, 1, 2]
unklogger.info(["Multiple", "Tags"], "I support multiple tags.");
// 2017-03-10 19:11:07 | [Multiple] [Tags] I support multiple tags.
```
### Configuration
```javascript
unklogger.$config = {
quiet: false, // Suppress output.
colors: true, // Enable colors.
console: Console, // Override console streams.
};
```
### Context
All output functions will return the `context` object as the first argument.
It contains the following properties:
* `$timestamp`: The current timestamp, same as output.
* `$tags`: All passed tags as an array.
* `$message`: All other arguments combined, as a string.
* `$output`: Text that was/will be logged to the console.
* `$arguments`: All arguments, exactly as passed to `unklogger`.
### Hooks
You can use the `beforeWrite` and `afterWrite` events to add hooks to perform any action. Multiple hooks can be bound to an event. Each is passed the current context.
```javascript
unklogger.addHook("beforeWrite", (context) => {
context.$output += " FOO";
});
unklogger.addHook("beforeWrite", (context) => {
context.$output += " BAR";
});
unklogger.addHook("afterWrite", (context) => {
axios.post("https://www.kream.io/logs", { output: context.$output });
});
// Outputs "ONE FOO BAR" and sends a POST request with the same output.
unklogger.info("ONE");
```
### Extensions
Extensions are functions returned by `unklogger`, which you can chain after the first call.
```javascript
unklogger.addExtension("send", (context, url) => {
axios.post(url, { output: context.$output });
});
unklogger.info("GO!").send("https://www.kream.io/logs");
```
## Tests
```bash
npm run test
```