Interface FancyConsoleLogger

A logger that outputs all messages to the console.

interface FancyConsoleLogger {
    errorCount: number;
    level: LogLevel;
    validationWarningCount: number;
    warningCount: number;
    addContext(
        message: string,
        level: Verbose | Info | Warn | Error,
        ...args: [MinimalNode?] | [number, MinimalSourceFile],
    ): string;
    error(text: TranslatedString, node?: MinimalNode): void;
    error(text: TranslatedString, pos: number, file: MinimalSourceFile): void;
    hasErrors(): boolean;
    hasWarnings(): boolean;
    info(text: TranslatedString): void;
    log(message: string, level: Verbose | Info | Warn | Error): void;
    resetErrors(): void;
    resetWarnings(): void;
    validationWarning(text: TranslatedString, node?: MinimalNode): void;
    validationWarning(
        text: TranslatedString,
        pos: number,
        file: MinimalSourceFile,
    ): void;
    verbose(text: string): void;
    warn(text: TranslatedString, node?: MinimalNode): void;
    warn(text: TranslatedString, pos: number, file: MinimalSourceFile): void;
}

Hierarchy (View Summary)

ConsoleLogger
- FancyConsoleLogger

Index

Methods

addContext error hasErrors hasWarnings info log resetErrors resetWarnings validationWarning verbose warn

Properties

errorCount level validationWarningCount warningCount

Methods

`Protected`addContext

addContext(
    message: string,
    level: Verbose | Info | Warn | Error,
    ...args: [MinimalNode?] | [number, MinimalSourceFile],
): string
Parameters
- message: string
- level: Verbose | Info | Warn | Error
- ...args: [MinimalNode?] | [number, MinimalSourceFile]
Returns string
Overrides ConsoleLogger.addContext
- Defined in lib/utils/loggers.ts:58

error

error(text: TranslatedString, node?: MinimalNode): void
Log the given error.
Parameters
- text: TranslatedString
  The error that should be logged.
- Optionalnode: MinimalNode
Returns void
Inherited from ConsoleLogger.error
- Defined in lib/utils-common/logger.ts:130
error(text: TranslatedString, pos: number, file: MinimalSourceFile): void
Log the given error.
Parameters
- text: TranslatedString
  The error that should be logged.
- pos: number
- file: MinimalSourceFile
Returns void
Inherited from ConsoleLogger.error
- Defined in lib/utils-common/logger.ts:131

hasErrors

hasErrors(): boolean
Has an error been raised through the log method?

Returns boolean
Inherited from ConsoleLogger.hasErrors
- Defined in lib/utils-common/logger.ts:53

hasWarnings

hasWarnings(): boolean
Has a warning been raised through the log method?

Returns boolean
Inherited from ConsoleLogger.hasWarnings
- Defined in lib/utils-common/logger.ts:60

info

info(text: TranslatedString): void
Log the given info message.
Parameters
- text: TranslatedString
Returns void
Inherited from ConsoleLogger.info
- Defined in lib/utils-common/logger.ts:89

log

log(message: string, level: Verbose | Info | Warn | Error): void
Print a log message.
Parameters
- message: string
- level: Verbose | Info | Warn | Error
  The urgency of the log message.
Returns void
Inherited from ConsoleLogger.log
- Defined in lib/utils-common/logger.ts:169

resetErrors

resetErrors(): void
Reset the error counter.

Returns void
Inherited from ConsoleLogger.resetErrors
- Defined in lib/utils-common/logger.ts:67

resetWarnings

resetWarnings(): void
Reset the warning counter.

Returns void
Inherited from ConsoleLogger.resetWarnings
- Defined in lib/utils-common/logger.ts:74

validationWarning

validationWarning(text: TranslatedString, node?: MinimalNode): void
Log the given warning and records that a validation warning has occurred.
Parameters
- text: TranslatedString
  The warning that should be logged.
- Optionalnode: MinimalNode
Returns void
Inherited from ConsoleLogger.validationWarning
- Defined in lib/utils-common/logger.ts:114
validationWarning(
    text: TranslatedString,
    pos: number,
    file: MinimalSourceFile,
): void
Log the given warning and records that a validation warning has occurred.
Parameters
- text: TranslatedString
  The warning that should be logged.
- pos: number
- file: MinimalSourceFile
Returns void
Inherited from ConsoleLogger.validationWarning
- Defined in lib/utils-common/logger.ts:115

verbose

verbose(text: string): void
Log the given verbose message.
Parameters
- text: string
  The message that should be logged.
Returns void
Inherited from ConsoleLogger.verbose
- Defined in lib/utils-common/logger.ts:84

warn

warn(text: TranslatedString, node?: MinimalNode): void
Log the given warning.
Parameters
- text: TranslatedString
  The warning that should be logged.
- Optionalnode: MinimalNode
Returns void
Inherited from ConsoleLogger.warn
- Defined in lib/utils-common/logger.ts:98
warn(text: TranslatedString, pos: number, file: MinimalSourceFile): void
Log the given warning.
Parameters
- text: TranslatedString
  The warning that should be logged.
- pos: number
- file: MinimalSourceFile
Returns void
Inherited from ConsoleLogger.warn
- Defined in lib/utils-common/logger.ts:99

Properties

errorCount

errorCount: number = 0

How many error messages have been logged?

level

level: LogLevel = LogLevel.Info

The minimum logging level to print.

validationWarningCount

validationWarningCount: number = 0

How many validation warning messages have been logged?

warningCount

warningCount: number = 0

How many warning messages have been logged?

Interface FancyConsoleLogger

Hierarchy (View Summary)

Index

Methods

Properties

Methods

ProtectedaddContext

Parameters

Returns string

error

Parameters

Returns void

Parameters

Returns void

hasErrors

Returns boolean

hasWarnings

Returns boolean

info

Parameters

Returns void

log

Parameters

Returns void

resetErrors

Returns void

resetWarnings

Returns void

validationWarning

Parameters

Returns void

Parameters

Returns void

verbose

Parameters

Returns void

warn

Parameters

Returns void

Parameters

Returns void

Properties

errorCount

level

validationWarningCount

warningCount

Settings

On This Page

`Protected`addContext