Loggical API Documentation v1.0.1
Loggical API Documentation v1.0.1
Enumerations
| Enumeration | Description |
|---|---|
| ColorLevel | - |
Classes
| Class | Description |
|---|---|
| Logger | Logger class for structured logging with colors and levels |
| ConsoleTransport | Transport that outputs logs to the console This is the default transport that maintains existing behavior |
| FileTransport | Simple transport that writes logs to files (Node.js only) Simplified version without log rotation or write queues |
| BaseTransport | Base transport class with common functionality |
Interfaces
| Interface | Description |
|---|---|
| LoggerOptions | Main configuration interface for Logger instances |
| RedactionConfig | Simple redaction configuration (kept for backward compatibility) |
| LogMetadata | Metadata passed to transports for each log message |
| TransportOptions | Configuration options for transports |
| Transport | Base transport interface that all transports must implement |
| ConsoleTransportOptions | Console transport specific options |
| FileTransportOptions | File transport specific options (simplified) |
Type Aliases
| Type Alias | Description |
|---|---|
| LogLevelType | - |
| ColorLevelType | - |
| RedactionOption | Simple redaction option - boolean only for basic sensitive key detection |
Variables
| Variable | Description |
|---|---|
| logger | Default logger instance with standard configuration |
| compactLogger | Compact logger optimized for space-efficient logging |
| readableLogger | Enhanced readable logger for development and debugging |
| serverLogger | Production logger optimized for server environments |
| LogLevel | Available log levels with their numeric priorities |
| LogLevelNames | Mapping from log level numeric values to their string names |