Interface LoxerCore

this is the main type of Loxer

Hierarchy

LoxerCore

Methods

Properties

history

Methods

init

init(options?: LoxerOptions): void

Initialize Loxer

Is a required function to initialize Loxer.
- if Loxer is not initialized, every log is cached until the initialization is done
- call this as soon as possible.
- ATTENTION: Do no conditionally leave out the initialization in order to avoid logging! All the logs will be cached anyways. If you want to conditionally disable Loxer then use one of the "disabled" options in the config(LoxerConfig) at the initialization
Parameters
- Optional options: LoxerOptions
  
  Options for the configuration of Loxer
Returns void

getModuleLevel

getModuleLevel(moduleID: string): LevelType | "-1"

Get a module's LogLevel

Returns the configured LogLevel (number) of the given moduleIss corresponding Module.
- is dependent on the environment: returns actual level (prod || dev)
- returns -1 if there is no corresponding module for the given moduleID
Parameters
- moduleID: string
Returns LevelType | "-1"

Properties

history

history: (OutputLox | ErrorLox)[]

Get the log History

This is a list of all logs / boxes / errors that occurred in the past. It must be enabled by initialization.

is a reversed stack, so that the most recent element is at history[0]
the size of the history can be set at the LoxerConfig.historyCacheSize in the LoxerOptions.config declared in Loxer.init(options). It defaults to 50.
if the history is enabled it will also be appended to the error logs in the errorOut callback

Generated using TypeDoc