Class PluginLogger

Hierarchy

Logger
- PluginLogger

Index

Constructors

Properties

errorCount level warningCount

Methods

addContext deprecated diagnostic diagnostics error hasErrors hasWarnings info log makeChildLogger resetErrors resetWarnings verbose warn

Constructors

constructor

new PluginLogger(_parent: Logger, _plugin: ABasePlugin, _context?: string): PluginLogger
Parameters
- _parent: Logger
- _plugin: ABasePlugin
- Optional _context: string
Returns PluginLogger
Overrides Logger.constructor
- Defined in packages/pluginutils/src/plugin-logger.ts:7

Properties

errorCount

errorCount: number

How many error messages have been logged?

level

level: LogLevel

The minimum logging level to print.

warningCount

warningCount: number

How many warning messages have been logged?

Methods

`Protected` addContext

addContext(message: string, _level: LogLevel, ..._args: [Node?] | [number, MinimalSourceFile]): string
Parameters
- message: string
- _level: LogLevel
- Rest ..._args: [Node?] | [number, MinimalSourceFile]
Returns string
Inherited from Logger.addContext
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:95

deprecated

deprecated(text: string | (() => string), addStack?: boolean): void
Log the given deprecation message.
Parameters
- text: string | (() => string)
  
  The message that should be logged.
- Optional addStack: boolean
  
  TODO: Not sure why ?
Returns void
Overrides Logger.deprecated
- Defined in packages/pluginutils/src/plugin-logger.ts:57

diagnostic

diagnostic(diagnostic: Diagnostic): void
Print the given TypeScript log message.
Parameters
- diagnostic: Diagnostic
  
  The TypeScript message that should be logged.
Returns void
Inherited from Logger.diagnostic
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:94

diagnostics

diagnostics(diagnostics: readonly Diagnostic[]): void
Print the given TypeScript log messages.
Parameters
- diagnostics: readonly Diagnostic[]
  
  The TypeScript messages that should be logged.
Returns void
Inherited from Logger.diagnostics
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:88

error

error(text: string | (() => string)): void
Log the given error message.
Parameters
- text: string | (() => string)
  
  The error that should be logged.
Returns void
Overrides Logger.error
- Defined in packages/pluginutils/src/plugin-logger.ts:72

hasErrors

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

Returns boolean
Inherited from Logger.hasErrors
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:36

hasWarnings

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

Returns boolean
Inherited from Logger.hasWarnings
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:40

info

info(text: string | (() => string)): void
Log the given info message.
Parameters
- text: string | (() => string)
  
  The message that should be logged.
Returns void
Overrides Logger.info
- Defined in packages/pluginutils/src/plugin-logger.ts:38

log

log(message: string | (() => string), level: LogLevel): void
Print a log message.
Parameters
- message: string | (() => string)
  
  The message itself.
- level: LogLevel
  
  The urgency of the log message.
Returns void
Overrides Logger.log
- Defined in packages/pluginutils/src/plugin-logger.ts:82

makeChildLogger

makeChildLogger(context?: string): PluginLogger
Create a new PluginLogger for the given context.

Returns
the new logger.
Parameters
- Optional context: string
  
  The new logger context.
Returns PluginLogger
- Defined in packages/pluginutils/src/plugin-logger.ts:18

resetErrors

resetErrors(): void
Reset the error counter.

Returns void
Inherited from Logger.resetErrors
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:44

resetWarnings

resetWarnings(): void
Reset the warning counter.

Returns void
Inherited from Logger.resetWarnings
- Defined in node_modules/typedoc/dist/lib/utils/loggers.d.ts:48

verbose

verbose(text: string | (() => string)): void
Log the given verbose message.
Parameters
- text: string | (() => string)
  
  The message that should be logged.
Returns void
Overrides Logger.verbose
- Defined in packages/pluginutils/src/plugin-logger.ts:29

warn

warn(text: string | (() => string)): void
Log the given warning message.
Parameters
- text: string | (() => string)
  
  The warning that should be logged.
Returns void
Overrides Logger.warn
- Defined in packages/pluginutils/src/plugin-logger.ts:47

Generated using TypeDoc