core/pro.respawn.flowmvi.logging

Package-level declarations

Types

fun interface StoreLogger

Store logger can be invoked by any code in the store. log prints a message to the logger instance configured when building the store.

enum StoreLogLevel : Enum<StoreLogLevel>

Log level of this store. Override when installing the plugin or leave as a default for sensible log levels. Log level may be represented using a system log level, such as on JS, Wasm, Android and iOS. On other platforms, log level will be represented as an emoji (StoreLogLevel.asSymbol).

Properties

val StoreLogLevel.asLogPriority: Int

Convert StoreLogLevel to Android Log priority.

val StoreLogLevel.asSymbol: String

Returns an emoji resembling this log level.

ConsoleStoreLogger

val ConsoleStoreLogger: StoreLogger

A logger that prints to console (println)

NoOpStoreLogger

val NoOpStoreLogger: StoreLogger

A StoreLogger that does nothing.

PlatformStoreLogger

expect val PlatformStoreLogger: StoreLogger

A StoreLogger instance for each supported platform

actual val PlatformStoreLogger: StoreLogger

Logger that prints to console.

actual val PlatformStoreLogger: StoreLogger

A StoreLogger implementation that prints to System.out

actual val PlatformStoreLogger: StoreLogger

A platform StoreLogger implementation that prints to console (alias for ConsoleStoreLogger)

actual val PlatformStoreLogger: StoreLogger

Alias for ConsoleStoreLogger

actual val PlatformStoreLogger: StoreLogger

A StoreLogger instance for each supported platform

Functions

fun StoreLogger.debug(tag: String? = null, message: () -> String)

Shorthand for log with StoreLogLevel.Debug as the log level.

fun StoreLogger.error(tag: String? = null, message: () -> String)

Shorthand for log with StoreLogLevel.Error as the log level.

fun StoreLogger.info(tag: String? = null, message: () -> String)

Shorthand for log with StoreLogLevel.Info as the log level.

operator fun StoreLogger.invoke(e: Exception, level: StoreLogLevel = StoreLogLevel.Error, tag: String? = null)

Alias for StoreLogger.log that can log exceptions

operator fun StoreLogger.invoke(level: StoreLogLevel, tag: String? = null, message: () -> String)

Alias for StoreLogger.log with optional parameters

fun PipelineContext<*, *, *>.log(e: Exception, level: StoreLogLevel = StoreLogLevel.Error, tag: String? = config.name)

fun PipelineContext<*, *, *>.log(level: StoreLogLevel = StoreLogLevel.Debug, tag: String? = config.name, message: () -> String)

Write a message to StoreLogger. Tag is the Store.name by default.

fun StoreLogger.trace(tag: String? = null, message: () -> String)

Shorthand for log with StoreLogLevel.Trace as the log level.

fun StoreLogger.warn(tag: String? = null, message: () -> String)

Shorthand for log with StoreLogLevel.Warn as the log level.