Loggical API Documentation v1.0.1

---

Loggical API Documentation / FileTransport

Class: FileTransport

Defined in: transports/file-transport.ts:17

Simple transport that writes logs to files (Node.js only) Simplified version without log rotation or write queues

Extends

• BaseTransport

Constructors

Constructor

new FileTransport(options: FileTransportOptions): FileTransport;

Defined in: transports/file-transport.ts:25

Parameters

Parameter	Type
options	FileTransportOptions

Returns

FileTransport

Overrides

BaseTransport.constructor

Properties

name

readonly name: "file" = 'file';

Defined in: transports/file-transport.ts:18

Unique name for this transport (for debugging/identification)

Overrides

BaseTransport.name

---

options

protected options: TransportOptions;

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

Inherited from

BaseTransport.options

Methods

write()

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

Defined in: transports/file-transport.ts:62

Write a formatted log message to this transport

Parameters

Parameter	Type	Description
formattedMessage	string	The complete formatted log message
metadata	LogMetadata	Additional metadata about the log entry

Returns

void

Overrides

BaseTransport.write

---

configure()

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

Defined in: transports/file-transport.ts:83

Configure or reconfigure this transport

Parameters

Parameter	Type	Description
options	Record<string, unknown>	Transport-specific configuration options

Returns

void

Overrides

BaseTransport.configure

---

getStatus()

getStatus(): Record<string, unknown>;

Defined in: transports/file-transport.ts:102

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

Returns

Record<string, unknown>

Overrides

BaseTransport.getStatus

---

close()

close(): Promise<void>;

Defined in: transports/file-transport.ts:129

Returns

Promise<void>

---

shouldWrite()

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

Parameter	Type
level	LogLevelType
message	string
metadata	LogMetadata

Returns

boolean

Inherited from

BaseTransport.shouldWrite

---

safeWrite()

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

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

Write with filtering and error handling

Parameters

Parameter	Type
formattedMessage	string
metadata	LogMetadata

Returns

Promise<void>

Inherited from

BaseTransport.safeWrite