API Docs Guides Support Pricing Download

Account

Class HiFiLogger

A wrapper for API-internal console.*() calls, gated by the user's current log level.

Hierarchy

HiFiLogger

Index

Constructors

constructor

Properties

logLevel

Methods

Constructors

constructor

new HiFiLogger(logLevel?: HiFiLogLevel): HiFiLogger

Parameters
- Optional logLevel: HiFiLogLevel
  
  The initial Log Level for our Logger.
Returns HiFiLogger

Properties

Static logLevel

logLevel: HiFiLogLevel = ...

Methods

Static debug

debug(message: string): boolean

Does the same thing as log.

Parameters
- message: string
Returns boolean

true if the message was output to the console; false otherwise.

Static error

error(message: string): boolean

If the Logger's log level is Debug or Warn or Error, will print an error log to the logs.

Parameters
- message: string
  
  The message to log.
Returns boolean

true if the message was output to the console; false otherwise.

Static log

log(message: string): boolean

If the Logger's log level is Debug, will print a debug log to the logs.

Parameters
- message: string
  
  The message to log.
Returns boolean

true if the message was output to the console; false otherwise.

Static setHiFiLogLevel

setHiFiLogLevel(newLogLevel: HiFiLogLevel): void

Sets a new HiFi Log Level.

Parameters
- newLogLevel: HiFiLogLevel
  
  The new Log Level for our Logger.
Returns void

Static warn

warn(message: string): boolean

If the Logger's log level is Debug or Warn, will print a warning log to the logs.

Parameters
- message: string
  
  The message to log.
Returns boolean

true if the message was output to the console; false otherwise.