Skip to content

Loggical API Documentation v1.0.1


Loggical API Documentation / ConsoleTransport

Class: ConsoleTransport

Defined in: transports/console-transport.ts:15

Transport that outputs logs to the console This is the default transport that maintains existing behavior

Extends

Constructors

Constructor

ts
new ConsoleTransport(options: ConsoleTransportOptions): ConsoleTransport;

Defined in: transports/console-transport.ts:21

Parameters

ParameterType
optionsConsoleTransportOptions

Returns

ConsoleTransport

Overrides

BaseTransport.constructor

Properties

name

ts
readonly name: "console" = 'console';

Defined in: transports/console-transport.ts:16

Unique name for this transport (for debugging/identification)

Overrides

BaseTransport.name


options

ts
protected options: TransportOptions;

Defined in: transports/transport.interface.ts:19

Inherited from

BaseTransport.options

Methods

write()

ts
write(formattedMessage: string, metadata: LogMetadata): void;

Defined in: transports/console-transport.ts:27

Write a formatted log message to this transport

Parameters

ParameterTypeDescription
formattedMessagestringThe complete formatted log message
metadataLogMetadataAdditional metadata about the log entry

Returns

void

Overrides

BaseTransport.write


configure()

ts
configure(options: Record<string, unknown>): void;

Defined in: transports/console-transport.ts:54

Configure or reconfigure this transport

Parameters

ParameterTypeDescription
optionsRecord<string, unknown>Transport-specific configuration options

Returns

void

Overrides

BaseTransport.configure


getStatus()

ts
getStatus(): Record<string, unknown>;

Defined in: transports/console-transport.ts:70

Get current configuration/status of this transport Useful for debugging and monitoring

Returns

Record<string, unknown>

Overrides

BaseTransport.getStatus


shouldWrite()

ts
protected shouldWrite(
   level: LogLevelType, 
   message: string, 
   metadata: LogMetadata): boolean;

Defined in: transports/transport.interface.ts:31

Check if this message should be processed by this transport

Parameters

ParameterType
levelLogLevelType
messagestring
metadataLogMetadata

Returns

boolean

Inherited from

BaseTransport.shouldWrite


safeWrite()

ts
safeWrite(formattedMessage: string, metadata: LogMetadata): Promise<void>;

Defined in: transports/transport.interface.ts:52

Write with filtering and error handling

Parameters

ParameterType
formattedMessagestring
metadataLogMetadata

Returns

Promise<void>

Inherited from

BaseTransport.safeWrite

Released under the MIT License.