Skip to content

Commit

Permalink
Update Provider documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NichtStudioCode committed Nov 6, 2024
1 parent c58c17b commit f05ad62
Showing 1 changed file with 1 addition and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import kotlin.reflect.KProperty
/**
* A [Provider] is a thread-safe, lazily-evaluated, reactive data source that holds a single value of type [T].
*
* There are various extension functions available for modelling atomic data transformations, such as [strongMap] and [strongFlatMap].
* There are various extension functions available for modelling atomic data transformations, such as [map] and [flatMap].
* It is important that all data transformation functions are pure, meaning that they are side effect free and
* do not access any mutable external state, in order to maintain the integrity of lazy evaluation. It is especially
* important that they do not resolve any other provider's value, **as doing so may risk deadlocks**.
Expand Down Expand Up @@ -49,8 +49,6 @@ sealed interface Provider<out T> : Supplier<@UnsafeVariance T> {
* The observer will be automatically removed when the [owner] is garbage collected.
*
* Contrary to [subscribeWeak], registering an observer does not disable lazy evaluation of the provider.
*
* The given value is not guaranteed to still be the current value at the time of invocation.
*/
fun <R : Any> observeWeak(owner: R, action: (owner: R) -> Unit)

Expand Down

0 comments on commit f05ad62

Please sign in to comment.