docs(defer)

hoc081098 · May 20, 2022 · 6a87141 · 6a87141
1 parent e86f6ad
commit 6a87141
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/commonMain/kotlin/com/hoc081098/flowext/defer.kt b/src/commonMain/kotlin/com/hoc081098/flowext/defer.kt
@@ -25,7 +25,14 @@
 package com.hoc081098.flowext
 
 import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.FlowCollector
 import kotlinx.coroutines.flow.emitAll
 import kotlinx.coroutines.flow.flow
 
+/**
+ * Creates a [Flow] that, on collection, calls a [Flow] factory to make a [Flow] for each new [FlowCollector].
+ *
+ * In some circumstances, waiting until the last minute (that is, until collection time)
+ * to generate the [Flow] can ensure that collectors receive the freshest data.
+ */
 public fun <T> defer(flowFactory: suspend () -> Flow<T>): Flow<T> = flow { emitAll(flowFactory()) }