Update docs and javascript to use inputs instead of mutationFlows

tunjid · Feb 14, 2024 · 81f8e9b · 81f8e9b
1 parent 40ff140
commit 81f8e9b
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/demo/src/commonMain/kotlin/com/tunjid/mutator/demo/sections/5_Formalizing.kt b/demo/src/commonMain/kotlin/com/tunjid/mutator/demo/sections/5_Formalizing.kt
@@ -43,7 +43,7 @@ private val twoCode = """
 fun <State: Any> CoroutineScope.stateFlowProducer(
     initialState: State,
     started: SharingStarted = SharingStarted.WhileSubscribed(),
-    mutationFlows: List<Flow<Mutation<State>>>
+    inputs: List<Flow<Mutation<State>>>
 ) : StateFlowProducer<State>
 """.trimIndent()
 
@@ -63,7 +63,7 @@ class Snail7StateHolder(
     private val stateProducer = scope.stateFlowProducer(
         initialState = Snail7State(),
         started = SharingStarted.WhileSubscribed(),
-        mutationFlows = listOf(
+        inputs = listOf(
             speedChanges,
             progressChanges,
         )

diff --git a/demo/src/commonMain/kotlin/com/tunjid/mutator/demo/sections/7_Conflict_Resolution.kt b/demo/src/commonMain/kotlin/com/tunjid/mutator/demo/sections/7_Conflict_Resolution.kt
@@ -180,7 +180,7 @@ class Snail11StateHolder(
     private val mutator = scope.actionStateFlowProducer<Action, Snail11State>(
         initialState = Snail11State(),
         started = SharingStarted.WhileSubscribed(),
-        mutationFlows = listOf(
+        inputs = listOf(
             speedChanges,
             progressChanges
         ),
@@ -239,7 +239,7 @@ private val nineMarkdown = """
     
 In the above, all there are two sources of state `Mutation`s:
 
-* Data sources in the `mutationFlows` argument; defined as `Flow<Mutation<State>>`
+* Data sources in the `inputs` argument; defined as `Flow<Mutation<State>>`
 * User events in the `actionTransform` argument; defined as `(Flow<Action>) -> Flow<Mutation<State>>`
    
 Crucially the `actionTransform` takes a `Flow` of all `Action` instances, splits them out into individual `Flow`s for each `Action`, and finally applies `Flow` transformations to each `Action` `Flow` to turn them into `Flow<Mutation<State>>`:

diff --git a/docs/demo.js b/docs/demo.js
diff --git a/docs/demo.js.map b/docs/demo.js.map
diff --git a/readme.md b/readme.md
@@ -109,7 +109,7 @@ class SnailStateHolder(
     private val stateProducer = scope.stateFlowProducer(
         initialState = Snail7State(),
         started = SharingStarted.WhileSubscribed(),
-        mutationFlows = listOf(
+        inputs = listOf(
             speedChanges,
             progressChanges,
         )