Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark runningWorker with no output as @Deprecated #996

Merged
merged 3 commits into from
Jul 6, 2023
Merged

Mark runningWorker with no output as @Deprecated #996

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eff6703
Mark runningWorker with no output as @Deprecated
crocsandcoffee May 2, 2023
a3e3e28
suppress warnings in tests
crocsandcoffee Jul 6, 2023
7358064
Apply changes from ktLintFormat
crocsandcoffee Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion workflow-core/src/commonMain/kotlin/com/squareup/workflow1/BaseRenderContext.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,10 +249,14 @@ public fun <PropsT, StateT, OutputT, ChildRenderingT>
* Ensures a [Worker] that never emits anything is running. Since [worker] can't emit anything,
* it can't trigger any [WorkflowAction]s.
*
* If your [Worker] does not output anything, then simply use [runningSideEffect].
* If your [Worker] does not output anything, then simply use [BaseRenderContext.runningSideEffect].
*
* @param key An optional string key that is used to distinguish between identical [Worker]s.
*/
@Deprecated(
message = "Use [BaseRenderContext.runningSideEffect] instead.",
replaceWith = ReplaceWith(expression = "runningSideEffect(key) { ... }", "")
)
public inline fun <reified W : Worker<Nothing>, PropsT, StateT, OutputT>
BaseRenderContext<PropsT, StateT, OutputT>.runningWorker(
worker: W,
Expand Down