workflow-runtime/com.squareup.workflow1

Package-level declarations

Types

NoopWorkflowInterceptor

object NoopWorkflowInterceptor : WorkflowInterceptor

A WorkflowInterceptor that does not intercept anything.

RenderingAndSnapshot

class RenderingAndSnapshot<out RenderingT>(val rendering: RenderingT, val snapshot: TreeSnapshot)

Tuple of rendering and snapshot used by renderWorkflowIn.

typealias RuntimeConfig = Set<RuntimeConfigOptions>

RuntimeConfigOptions

enum RuntimeConfigOptions : Enum<RuntimeConfigOptions>

A specification of the possible Workflow Runtime options.

SimpleLoggingWorkflowInterceptor

open class SimpleLoggingWorkflowInterceptor : WorkflowInterceptor

A WorkflowInterceptor that just prints all method calls using log.

class TreeSnapshot

Aggregate of all the snapshots of a tree of workflows.

WorkflowExperimentalRuntime

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS])

annotation class WorkflowExperimentalRuntime

This is used to mark any experimental runtimes.

WorkflowInterceptor

interface WorkflowInterceptor

Provides hooks into the workflow runtime that can be used to instrument or modify the behavior of workflows.

Functions

renderWorkflowIn

fun <PropsT, OutputT, RenderingT> renderWorkflowIn(workflow: Workflow<PropsT, OutputT, RenderingT>, scope: CoroutineScope, props: StateFlow<PropsT>, initialSnapshot: TreeSnapshot? = null, interceptors: List<WorkflowInterceptor> = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): StateFlow<RenderingAndSnapshot<RenderingT>>

Launches the workflow in a new coroutine in scope and returns a StateFlow of its renderings and snapshots. The workflow tree is seeded with initialSnapshot and the current value value of props. Subsequent values emitted from props will be used to re-render the workflow.