NestJsLoggerAdapter
Package: @nauth-toolkit/nestjs
Type: Logger Adapter
Wraps NestJS's built-in Logger to implement NAuth's LoggerProvider interface. Includes automatic PII redaction for emails, IPs, and tokens.
Import
import { NestJsLoggerAdapter } from '@nauth-toolkit/nestjs';
Usage
import { NestJsLoggerAdapter } from '@nauth-toolkit/nestjs';
const logger = new NestJsLoggerAdapter({ context: 'NAuth' });
Constructor
new NestJsLoggerAdapter(options?: {
context?: string;
enablePiiRedaction?: boolean;
piiRedactionOptions?: Record<string, unknown>;
})
| Parameter | Type | Description |
|---|---|---|
options | object | Optional configuration |
options.context | string | Logger context label. Default: 'nauth-toolkit' |
options.enablePiiRedaction | boolean | Redact PII from log output. Default: true |
options.piiRedactionOptions | Record<string, unknown> | Custom PII redaction options |
Methods
| Method | Description |
|---|---|
log(message: string, metadata?: LogMetadata) | Info level log |
error(message: string, metadata?: LogMetadata) | Error level log |
warn(message: string, metadata?: LogMetadata) | Warning level log |
debug(message: string, metadata?: LogMetadata) | Debug level log |
setLogLevel(level: LogLevel) | Set log level at runtime |
isLevelEnabled(level: LogLevel) | Check whether a log level is enabled |
Auto-Configuration
When using AuthModule.forRoot(), the logger is automatically configured. Manual setup is only needed for custom logging.