Class CLILogger

Manages logging services for the CLI through log4js

Hierarchy

CLILogger

Implements

ICLILogger

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CLILogger(initOptions?: Partial<ICLILoggerOptions>): CLILogger

- Defined in src/cliLogger.ts:112
Parameters
- Default value initOptions: Partial<ICLILoggerOptions> = {}
  
  The user's partial init options
Returns CLILogger

Properties

Private Readonly engine

engine: Logger

The log4js logging engine

Private Readonly options

options: ICLILoggerOptions

Logger initialization options

Methods

Private configureLogger

configureLogger(): void

- Defined in src/cliLogger.ts:137
Configures the logger log4js engine

Returns void

debug

debug(message: string): void

- Defined in src/cliLogger.ts:106
Parameters
- message: string
Returns void

error

error(message: string): void

- Defined in src/cliLogger.ts:98
Parameters
- message: string
Returns void

Private getLoggerOptions

getLoggerOptions(initOptions: Partial<ICLILoggerOptions>): ICLILoggerOptions

- Defined in src/cliLogger.ts:171
Builds the full logger init options from the user's partial options and the default options

Parameters
- initOptions: Partial<ICLILoggerOptions>
  
  The user's init options
Returns ICLILoggerOptions

The full logger options

info

info(message: string): void

- Defined in src/cliLogger.ts:94
Parameters
- message: string
Returns void

log

log(message: string): void

- Defined in src/cliLogger.ts:90
Parameters
- message: string
Returns void

trace

trace(message: string): void

- Defined in src/cliLogger.ts:110
Parameters
- message: string
Returns void

warn

warn(message: string): void

- Defined in src/cliLogger.ts:102
Parameters
- message: string
Returns void

Static closeLogger

closeLogger(): Promise<void>

- Defined in src/cliLogger.ts:83
Closes the active logger instance (if applicable)

Returns Promise<void>

Generated using TypeDoc