Class UFFileLog

Implements IUFLog to write log entries to both a file and to the console.

Hierarchy

UFFileLog

Implements

IUFLog

Index

Constructors

Methods

debug error info log

Constructors

constructor

new UFFileLog(aFileName: string): UFFileLog
Creates a log instance.
Parameters
- aFileName: string
  
  Name of file including path. The file name may include the macro text '$date$', which will get replaced with current date. This will group log entries per day.
Returns UFFileLog
- Defined in log/UFFileLog.ts:50

Methods

debug

debug(aPrefix: string, ...aData: any[]): void
Writes a debug entry to the log. If there is a commandline argument 'nodebug' the data is not output to the console.
Parameters
- aPrefix: string
  
  A prefix for the entry
- Rest ...aData: any[]
  
  Additional entries to write
Returns void
Implementation of IUFLog.debug
- Defined in log/UFFileLog.ts:61

error

error(aPrefix: string, anError: any, aDescription?: string, ...aData: any[]): void
Writes an error entry to the log.
Parameters
- aPrefix: string
  
  A prefix for the entry
- anError: any
  
  An error object to write or null to create a general error entry
- aDescription: string = ''
  
  A description of the action that was being performed that caused the error
- Rest ...aData: any[]
  
  Additional entries to write
Returns void
Implementation of IUFLog.error
- Defined in log/UFFileLog.ts:82

info

info(aPrefix: string, ...aData: any[]): void
Writes an info entry to the log.
Parameters
- aPrefix: string
  
  A prefix for the entry
- Rest ...aData: any[]
  
  Additional entries to write
Returns void
Implementation of IUFLog.info
- Defined in log/UFFileLog.ts:68

log

log(...aData: any[]): void
Writes an entry to the log.
Parameters
- Rest ...aData: any[]
  
  Entries to write
Returns void
Implementation of IUFLog.log
- Defined in log/UFFileLog.ts:75

Generated using TypeDoc