1.0.1 ⢠Published 5 months ago
0xlogs v1.0.1
0xLogs
0xLogs is a lightweight and configurable logging utility for Node.js applications. It supports JSON parsing, file output, and built-in process event logging to help monitor your app's health and behavior with minimal setup.
š¦ Installation
npm install 0xlogs
š Features
- Logging with custom levels:
info
,warn
,error
,debug
- Optional JSON formatting
- File logging support
- Safe schema validation
- Auto-handling for:
uncaughtException
unhandledRejection
SIGINT
,SIGTERM
,exit
- Warnings and IPC messages
š ļø Usage
Basic Example
const CreateLog = require("0xlogs");
const log = new CreateLog({
type: "info",
filePath: "./logs.txt",
json: true
});
log("App started", { port: 3000 });
Update Config
log.setConfig({
type: "error",
json: false
});
āļø Config Options
Option | Type | Default | Description |
---|---|---|---|
type | String | info | Log level (info , warn , error , debug ) |
filePath | String | undefined | Path to output log file (optional) |
json | Boolean | true | Enable JSON formatting for logs |
š Built-in Process Logging
When require("0xlogs")
is invoked, it automatically logs:
- Uncaught exceptions and rejections
- Signals like
SIGINT
,SIGTERM
- Process exit events
- IPC messages (
process.send
) - Warnings
Example logs:
[~] [ERROR] Uncaught Exception: ...
[~] [INFO] Exited Application.
[~] [WARN] A promise rejection was handled asynchronously: ...
š File Structure (for contributors)
0xlogs/
āāā lib/
ā āāā index.js # Combines validation utilities and config types
ā āāā process/
ā ā āāā index.js # Handles process-level logging
ā āāā types/
ā ā āāā index.js # Schema definition
ā āāā functions/
ā ā āāā index.js # Config & path validation
āāā index.js # Main class (CreateLog)
š License
MIT Ā© 2025