Class Logger

Hierarchy

Logger

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Logger(options?: ILoggerOptions): Logger

- Defined in logger.ts:42
Parameters
- Optional options: ILoggerOptions
Returns Logger

Properties

options

options: ILoggerOptions

stream

stream: WritableStream

Methods

Private colorize

colorize(val: any, styles: string | string[]): string | any[]

- Defined in logger.ts:78
Colorize Applies ansi styles to value.

Parameters
- val: any
  
  the value to be colorized.
- styles: string | string[]
  
  the styles to be applied.
Returns string | any[]

Private colorizeIf

colorizeIf(val: any, styles: string | string[]): any

- Defined in logger.ts:89
Colorize If If colors are enabled apply ansi styles to value.

Parameters
- val: any
  
  the value to be colorized.
- styles: string | string[]
  
  the styles to be applied.
Returns any

debug

debug(...args: any[]): Logger

- Defined in logger.ts:361
Parameters
- Rest ...args: any[]
Returns Logger

error

error(...args: any[]): Logger

- Defined in logger.ts:349
Parameters
- Rest ...args: any[]
Returns Logger

exit

exit(code?: number): void

- Defined in logger.ts:376
Parameters
- Optional code: number
Returns void

get

get<T>(key: string): T

- Defined in logger.ts:322
Get Gets a current option value.

Type parameters
- T
Parameters
- key: string
  
  the option key to get.
Returns T

Private getIndex

getIndex(key: any, arr: any[]): number

- Defined in logger.ts:67
Get Index Gets the index of a value in an array.

Parameters
- key: any
  
  the key to get the index for.
- arr: any[]
  
  the array to be inspected.
Returns number

Private getTimestamp

getTimestamp(format?: boolean | "time" | "date"): string

- Defined in logger.ts:176
Get Timestamp Gets a timestamp by format.

Parameters
- Optional format: boolean | "time" | "date"
  
  the format to return.
Returns string

info

info(...args: any[]): Logger

- Defined in logger.ts:357
Parameters
- Rest ...args: any[]
Returns Logger

Private logger

logger(type: string, ...args: any[]): this

- Defined in logger.ts:220
Logger Private common logger method.

Parameters
- type: string
  
  the type of log message to log.
- Rest ...args: any[]
  
  the arguments to be logged.
Returns this

Private parseStack

parseStack(stack: any, prune?: number, depth?: number): IStacktraceResult

- Defined in logger.ts:103
Parse Stack Simple stack parser to limit and stylize stacktraces.

Parameters
- stack: any
  
  the stacktrace to be parsed.
- Optional prune: number
  
  number of stack frames to prune.
- Optional depth: number
  
  the depth to trace.
Returns IStacktraceResult

set

set(key: string | ILoggerOptions, value: any): void

- Defined in logger.ts:333
Set Sets options for Logger.

Parameters
- key: string | ILoggerOptions
  
  the key or options object to be set.
- value: any
  
  the value for the key.
Returns void

Private toggleExceptionHandler

toggleExceptionHandler(capture?: boolean): void

- Defined in logger.ts:206
Toggle Exception Handler Toggles uncaughtException listener.

Parameters
- Optional capture: boolean
  
  whether to capture uncaught exceptions or not.
Returns void

Private uncaughtException

uncaughtException(err: Error): void

- Defined in logger.ts:192
Uncaught Exception Handler for uncaught excrptions.

Parameters
- err: Error
  
  the error caught by process uncaughtException.
Returns void

warn

warn(...args: any[]): Logger

- Defined in logger.ts:353
Parameters
- Rest ...args: any[]
Returns Logger

write

write(...args: any[]): Logger

- Defined in logger.ts:365
Parameters
- Rest ...args: any[]
Returns Logger

Generated using TypeDoc