Skip to content

portapack


portapack / index / Logger

Class: Logger

Defined in: utils/logger.ts:23

A simple logger class that allows filtering messages based on severity levels. Uses standard console methods (debug, info, warn, error) for output.

Constructors

Constructor

new Logger(level?): Logger

Defined in: utils/logger.ts:34

Creates a new Logger instance. Defaults to LogLevel.INFO if no level is provided.

Parameters

level?

LogLevel = LogLevel.INFO

The initial log level for this logger instance. Must be one of the values from the LogLevel enum.

Returns

Logger

Properties

level

level: LogLevel

Defined in: utils/logger.ts:25

The current minimum log level required for a message to be output.

Methods

debug()

debug(message): void

Defined in: utils/logger.ts:54

Logs a debug message if the current log level is DEBUG or higher.

Parameters

message

string

The debug message string.

Returns

void


error()

error(message): void

Defined in: utils/logger.ts:90

Logs an error message if the current log level is ERROR or higher.

Parameters

message

string

The error message string.

Returns

void


fromLevelName()

static fromLevelName(levelName?, defaultLevel?): Logger

Defined in: utils/logger.ts:119

Static factory method to create a Logger instance based on a LogLevel string name. Useful for creating a logger from config files or environments variables.

Parameters

levelName?

string

The name of the log level (e.g., 'debug', 'info', 'warn', 'error', 'silent'/'none'). Case-insensitive.

defaultLevel?

LogLevel = LogLevel.INFO

The level to use if levelName is invalid or undefined.

Returns

Logger

A new Logger instance set to the corresponding LogLevel.

Static


fromVerboseFlag()

static fromVerboseFlag(options?): Logger

Defined in: utils/logger.ts:105

Static factory method to create a Logger instance based on a simple boolean verbose flag.

Parameters

options?

An object potentially containing a verbose flag.

verbose?

boolean

Returns

Logger

A new Logger instance set to LogLevel.DEBUG if options.verbose is true, otherwise set to LogLevel.INFO.

Static


info()

info(message): void

Defined in: utils/logger.ts:66

Logs an informational message if the current log level is INFO or higher.

Parameters

message

string

The informational message string.

Returns

void


setLevel()

setLevel(level): void

Defined in: utils/logger.ts:45

Updates the logger's current level. Messages below this level will be suppressed.

Parameters

level

LogLevel

The new log level to set. Must be a LogLevel enum member.

Returns

void


warn()

warn(message): void

Defined in: utils/logger.ts:78

Logs a warning message if the current log level is WARN or higher.

Parameters

message

string

The warning message string.

Returns

void

Released under the MIT License