LoggerBase | vscode-powertools

A basic logger.

Hierarchy

EventEmitter
- LoggerBase
  - ActionLogger

Implements

Logger

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LoggerBase(options?: EventEmitterOptions): LoggerBase

Inherited from Events.EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional options: EventEmitterOptions
Returns LoggerBase

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.addListener

Inherited from Events.EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

alert

alert(msg: any, tag?: string): LoggerBase

Implementation of Logger.alert
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:157
Logs an alert message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

crit

crit(msg: any, tag?: string): LoggerBase

Implementation of Logger.crit
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:159
Logs a critical message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

debug

debug(msg: any, tag?: string): LoggerBase

Implementation of Logger.debug
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:161
Logs a debug message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

emerg

emerg(msg: any, tag?: string): LoggerBase

Implementation of Logger.emerg
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:163
Logs an emergency message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

emit

emit(event: string | symbol, ...args: any[]): boolean

Implementation of Logger.emit

Inherited from Events.EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

err

err(msg: any, tag?: string): LoggerBase

Implementation of Logger.err
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:165
Logs an error message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

eventNames

eventNames(): (string | symbol)[]

Implementation of Logger.eventNames

Inherited from Events.EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Implementation of Logger.getMaxListeners

Inherited from Events.EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64
Returns number

info

info(msg: any, tag?: string): LoggerBase

Implementation of Logger.info
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:167
Logs an info message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

listenerCount

listenerCount(event: string | symbol): number

Implementation of Logger.listenerCount

Inherited from Events.EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of Logger.listeners

Inherited from Events.EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

log

log(type: LogType, msg: any, tag?: string): Promise<void>

Implementation of Logger.log
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:169
Logs a message.

inheritdoc

Parameters
- type: LogType
- msg: any
- Optional tag: string
Returns Promise<void>

Protected logSync

logSync(type: LogType, msg: any, tag?: string): LoggerBase

- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:177
Sync logging.

Parameters
- type: LogType
  
  The type.
- msg: any
  
  The message.
- Optional tag: string
Returns LoggerBase

Protected normalizeTag

normalizeTag(tag: string): string

- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:185
Normalizes a tag value.

Parameters
- tag: string
  
  The input value.
Returns string

The output value.

notice

notice(msg: any, tag?: string): LoggerBase

Implementation of Logger.notice
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:187
Logs a note message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

off

off(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.off

Inherited from Events.EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

on

on(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.on

Inherited from Events.EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:58
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

Protected Abstract onLog

onLog(context: LogContext): Promise<any>

- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:195
The logic for logging a message.

Parameters
- context: LogContext
  
  The context.
Returns Promise<any>

Invoke log event or not.

once

once(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.once

Inherited from Events.EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:59
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.prependListener

Inherited from Events.EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.prependOnceListener

Inherited from Events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

rawListeners

rawListeners(event: string | symbol): Function[]

Implementation of Logger.rawListeners

Inherited from Events.EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): LoggerBase

Implementation of Logger.removeAllListeners

Inherited from Events.EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns LoggerBase

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): LoggerBase

Implementation of Logger.removeListener

Inherited from Events.EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns LoggerBase

setMaxListeners

setMaxListeners(n: number): LoggerBase

Implementation of Logger.setMaxListeners

Inherited from Events.EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns LoggerBase

trace

trace(msg: any, tag?: string): LoggerBase

Implementation of Logger.trace
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:197
Logs a trace message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

warn

warn(msg: any, tag?: string): LoggerBase

Implementation of Logger.warn
- Defined in node_modules/vscode-helpers/lib/logging/index.d.ts:199
Logs a warning message.

inheritdoc

Parameters
- msg: any
- Optional tag: string
Returns LoggerBase

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Events.EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from Events.EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from Events.EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Events.EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns LoggerBase

Properties

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns LoggerBase

alert

Parameters

msg: any

Optional tag: string

Returns LoggerBase

crit

Parameters

msg: any

Optional tag: string

Returns LoggerBase

debug

Parameters

msg: any

Optional tag: string

Returns LoggerBase

emerg

Parameters

msg: any

Optional tag: string

Returns LoggerBase

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

err

Parameters

msg: any

Optional tag: string

Returns LoggerBase

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

info

Parameters

msg: any

Optional tag: string

Returns LoggerBase

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

log

Parameters

type: LogType

msg: any

Optional tag: string

Returns Promise<void>

Protected logSync

Parameters