API Reference
Rockets Core API
nestjs-logger
classes
LoggerTransportService

Class: LoggerTransportService

A transport service that will load all third party transport that will be used to log messages to external

Example

class TestTransport implements LoggerTransportInterface {
    log(): void {
      // forward message to transport
    }
}
 
const app = await NestFactory.create(AppModule, {
  logger: loggerConfig().logLevel,
});
 
const customLoggerService = app.get(LoggerService);
 
const testTransport = new TestTransport();
 
customLoggerService.addTransport(testTransport);

Constructors

new LoggerTransportService()

new LoggerTransportService(settings): LoggerTransportService

Constructor

Parameters

ParameterTypeDescription
settingsLoggerSettingsInterfacelogger settings

Returns

LoggerTransportService

Defined in

packages/nestjs-logger/src/logger-transport.service.ts:47 (opens in a new tab)

Properties

PropertyModifierTypeDescription
settingsreadonlyLoggerSettingsInterfacelogger settings

Methods

addTransport()

addTransport(transport): void

Method to add the transport that will be used

Parameters

ParameterTypeDescription
transportLoggerTransportInterfaceInstance of a logger transport

Returns

void

Defined in

packages/nestjs-logger/src/logger-transport.service.ts:61 (opens in a new tab)


log()

log(message, logLevel, error?): void

Method to log message to the transport based on the log level

Parameters

ParameterTypeDescription
messagestringmessage
logLevelLogLevellog level
error?Errorerror

Returns

void

Defined in

packages/nestjs-logger/src/logger-transport.service.ts:72 (opens in a new tab)