@interopio/desktop API Reference

Access via:io.logger

Properties (2)

Property Type Default Required Description
name⚓︎ string x

Name of the logger.
version⚓︎ string x x

Version of the Logging API.

10 Methods

canPublish()⚓︎

(level: LogLevel) => boolean

Checks if the logger can publish a log level

Parameters (1)

Name Type Required Description
level⚓︎ LogLevel x

consoleLevel()⚓︎

(level?: LogLevel) => LogLevel | undefined

Sets or gets the current threshold level for writing to the console.

Parameters (1)

Name Type Required Description
level⚓︎ LogLevel x

Logger level.

debug()⚓︎

(message: string) => void

Method for logging messages at "debug" level.

Parameters (1)

Name Type Required Description
message⚓︎ string

Message to log.

error()⚓︎

(message: string, err?: Error) => void

Method for logging messages at "error" level.

Parameters (2)

Name Type Required Description
message⚓︎ string

Message to log.
err⚓︎ Error x x

info()⚓︎

(message: string) => void

Method for logging messages at "info" level.

Parameters (1)

Name Type Required Description
message⚓︎ string

Message to log.

log()⚓︎

(message: string, level?: LogLevel) => void

Logging method.

Parameters (2)

Name Type Required Description
message⚓︎ string

Message to log.
level⚓︎ LogLevel x

Logging level for the message.

publishLevel()⚓︎

(level?: LogLevel) => LogLevel | undefined

Sets or gets the current threshold level for publishing to a file.

Parameters (1)

Name Type Required Description
level⚓︎ LogLevel x

Logger level.

subLogger()⚓︎

(name: string) => API

Creates a new logger which is a sub-logger of the current one.

Parameters (1)

Name Type Required Description
name⚓︎ string

Name for the sub-logger.

trace()⚓︎

(message: string) => void

Method for logging messages at "trace" level.

Parameters (1)

Name Type Required Description
message⚓︎ string

Message to log.

warn()⚓︎

(message: string) => void

Method for logging messages at "warn" level.

Parameters (1)

Name Type Required Description
message⚓︎ string

Message to log.