ConsumeBoomerangLifecycleEffect

@Composable
inline fun ConsumeBoomerangLifecycleEffect(key: String, lifecycleEvent: Lifecycle.Event = Lifecycle.Event.ON_START, crossinline catcher: (Boomerang) -> Unit)(source)

A Composable effect that tries to catch a boomerang value from the BoomerangStore when a specific lifecycle event occurs. This is an inline version that accepts a lambda function instead of a BoomerangCatcher. This effect is typically used to process data that was stored in the BoomerangStore when the UI becomes visible. Example usage

Parameters

key

The key to try to catch the value for

lifecycleEvent

The lifecycle event that triggers the catch attempt (default is ON_START)

catcher

Lambda function that will be called with the caught Boomerang value

Throws

if the lifecycleEvent is not ON_START or ON_RESUME