Interface INotifier

Interface that provides notification.

interface INotifier {
    debug(message: string, options?: NotifierOptions): void;
    error(error: string | Error, options?: NotifierOptions): void;
    log(message: string, options?: NotifierOptions): void;
    warn(message: string, options?: NotifierOptions): void;
}

Implemented by

DefaultNotifier

Index

Methods

debug error log warn

Methods

debug

debug(message: string, options?: NotifierOptions): void
For debug logging.
Parameters
- message: string
  The debug message to display.
- Optionaloptions: NotifierOptions
  Options for the debug notification.
Returns void

error

error(error: string | Error, options?: NotifierOptions): void
Should return error object exception.
Parameters
- error: string | Error
  The error message or object to display.
- Optionaloptions: NotifierOptions
  Options for the error notification.
Returns void

log

log(message: string, options?: NotifierOptions): void
Useful when informing the user of something but are not expecting a response.
Parameters
- message: string
  The log message to display.
- Optionaloptions: NotifierOptions
  Options for the log notification.
Returns void

warn

warn(message: string, options?: NotifierOptions): void
Should return error object exception.
Parameters
- message: string
  The warning message to display.
- Optionaloptions: NotifierOptions
  Options for the warning notification.
Returns void