Class POSTLogger

POSTLogger publishes log messages in batches to a URL supplied during its construction.

Be sure to call POSTLogger.destroy when you're done with the logger in order to avoid leaks.

Hierarchy

POSTLogger

Implements

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new POSTLogger(options: POSTLoggerOptions): POSTLogger

- Defined in src/logger/POSTLogger.ts:31
Parameters
- options: POSTLoggerOptions
Returns POSTLogger

Properties

metadata

metadata: Record<string, string>

Methods

addEventListener

addEventListener(): void

- Defined in src/logger/POSTLogger.ts:58
Returns void

debug

debug(debugFunction: string | (() => string)): void

Implementation of Logger.debug
- Defined in src/logger/POSTLogger.ts:72
Calls [[debugFunction]] only if the log level is debug and emits the resulting string. Use the debug level to dump large or verbose messages that could slow down performance.

Parameters
- debugFunction: string | (() => string)
Returns void

destroy

destroy(): Promise<void>

Implementation of Destroyable.destroy
- Defined in src/logger/POSTLogger.ts:155
Permanently clean up the logger. A new logger must be created to resume logging.

Returns Promise<void>

error

error(msg: string): void

Implementation of Logger.error
- Defined in src/logger/POSTLogger.ts:94
Emits an error message if the log level is equal to or lower than error level.

Parameters
- msg: string
Returns void

getLogCaptureSize

getLogCaptureSize(): number

- Defined in src/logger/POSTLogger.ts:106
Returns number

getLogLevel

getLogLevel(): LogLevel

Implementation of Logger.getLogLevel
- Defined in src/logger/POSTLogger.ts:102
Gets the current log level.

Returns LogLevel

info

info(msg: string): void

Implementation of Logger.info
- Defined in src/logger/POSTLogger.ts:86
Emits an info message if the log level is equal to or lower than info level.

Parameters
- msg: string
Returns void

removeEventListener

removeEventListener(): void

- Defined in src/logger/POSTLogger.ts:65
Returns void

setLogLevel

setLogLevel(logLevel: LogLevel): void

Implementation of Logger.setLogLevel
- Defined in src/logger/POSTLogger.ts:98
Sets the log level.

Parameters
- logLevel: LogLevel
Returns void

warn

warn(msg: string): void

Implementation of Logger.warn
- Defined in src/logger/POSTLogger.ts:90
Emits a warning message if the log level is equal to or lower than warn level.

Parameters
- msg: string
Returns void

Generated using TypeDoc