workflow

package

Go to main page

Versions in this module

v0

v0.7.0

Jun 25, 2026

Changes in this version

type FlowOptions

+ DeleteOnCompletion bool

+ TimeBudget time.Duration

v0.6.3

Jun 22, 2026

v0.6.2

Jun 22, 2026

Changes in this version

type Graph

+ func (g *Graph) AddTransitionFanOut(from string, to ...string)

v0.6.1

Jun 22, 2026

v0.6.0

Jun 22, 2026

Changes in this version

type Flow

+ func (f *Flow) Attempt() int

+ func (f *Flow) StepCreatedAt() time.Time

type RawFlow

+ func (f *RawFlow) SetCreatedAt(createdAt time.Time)

+ func (f *RawFlow) SetStepCreatedAt(stepCreatedAt time.Time)

+ func (f *RawFlow) SetUpdatedAt(updatedAt time.Time)

v0.5.0

Jun 18, 2026

Changes in this version

type Flow

+ func (f *Flow) Subtask(name, taskURL string, in any, out any) (yield bool, err error)

type Graph

+ func (g *Graph) AddTransitionChain(names ...string)

+ func (g *Graph) SetEndpoint(name, url string)

v0.4.1

Jun 16, 2026

v0.4.0

Jun 16, 2026

Changes in this version

+ func ErrRateLimited(err error, cause string) error

+ func ErrUnavailable(err error, cause string) error

+ func IsRateLimited(err error) (cause string, ok bool)

+ func IsUnavailable(err error) (cause string, ok bool)

type Flow

+ func (f *Flow) FlowKey() string

+ func (f *Flow) StepKey() string

type FlowOptions

+ NotifyOnStop bool

type FlowStep

+ Parked bool

+ SubWorkflowURL string

type FlowSummary

+ WorkflowURL string

type Graph

+ func (g *Graph) URL() string

type Query

+ WorkflowURL string

type RawFlow

+ func (f *RawFlow) SetFlowKey(flowKey string)

+ func (f *RawFlow) SetStepKey(stepKey string)

v0.3.2

Jun 14, 2026

v0.3.1

Jun 14, 2026

v0.3.0

Jun 14, 2026

v0.2.0

Jun 13, 2026

v0.1.0

Jun 13, 2026

Changes in this version

+ const END

+ const StatusCancelled

+ const StatusCompleted

+ const StatusCreated

+ const StatusFailed

+ const StatusInterrupted

+ const StatusPending

+ const StatusRunning

+ func BaggageFrom(ctx context.Context) any

+ func ContextWithBaggage(ctx context.Context, baggage any) context.Context

+ func ErrBackpressure(err error, cause string) error

+ func ErrBreakerTrip(err error, cause string) error

+ func IsBackpressure(err error) (cause string, ok bool)

+ func IsBreakerTrip(err error) (cause string, ok bool)

+ func MergeState(state any, changes any, reducers map[string]Reducer) (map[string]any, error)

+ type Flow struct

+ func NewFlow() *Flow

+ func (f *Flow) Clear()

+ func (f *Flow) CreatedAt() time.Time

+ func (f *Flow) Delete(keys ...string)

+ func (f *Flow) Get(key string, target any) error

+ func (f *Flow) GetBool(key string) bool

+ func (f *Flow) GetDuration(key string) time.Duration

+ func (f *Flow) GetFloat(key string) float64

+ func (f *Flow) GetInt(key string) int

+ func (f *Flow) GetString(key string) string

+ func (f *Flow) GetStrings(key string) []string

+ func (f *Flow) Goto(taskName string)

+ func (f *Flow) GotoRequested() string

+ func (f *Flow) Has(key string) bool

+ func (f *Flow) Interrupt(payload any) (resumeData map[string]any, yield bool, err error)

+ func (f *Flow) InterruptRequested() (map[string]any, bool)

+ func (f *Flow) MarshalJSON() ([]byte, error)

+ func (f *Flow) ParseState(target any) error

+ func (f *Flow) Retry(maxAttempts int, initialDelay time.Duration, multiplier float64, ...) bool

+ func (f *Flow) RetryRequested() (maxAttempts int, initialDelay time.Duration, multiplier float64, ...)

+ func (f *Flow) Set(key string, value any) error

+ func (f *Flow) SetBool(key string, value bool)

+ func (f *Flow) SetChanges(source any, snap map[string]any) error

+ func (f *Flow) SetDuration(key string, value time.Duration)

+ func (f *Flow) SetFloat(key string, value float64)

+ func (f *Flow) SetInt(key string, value int)

+ func (f *Flow) SetState(source any) error

+ func (f *Flow) SetString(key string, value string)

+ func (f *Flow) SetStrings(key string, value []string)

+ func (f *Flow) Sleep(duration time.Duration)

+ func (f *Flow) SleepRequested() time.Duration

+ func (f *Flow) Snapshot() map[string]any

+ func (f *Flow) Subgraph(workflowURL string, input map[string]any) (out map[string]any, yield bool, err error)

+ func (f *Flow) SubgraphRequested() (workflowURL string, input map[string]any, ok bool)

+ func (f *Flow) Transform(pairs ...string)

+ func (f *Flow) UnmarshalJSON(data []byte) error

+ func (f *Flow) UpdatedAt() time.Time

+ type FlowOptions struct

+ Baggage any

+ FairnessKey string

+ FairnessWeight float64

+ Priority int

+ StartAt time.Time

+ type FlowOutcome struct

+ CancelReason string

+ Error string

+ FlowKey string

+ InterruptPayload map[string]any

+ State map[string]any

+ Status string

+ type FlowRenderer struct

+ func NewFlowRenderer(steps []FlowStep) *FlowRenderer

+ func (r *FlowRenderer) Render() (string, error)

+ func (r *FlowRenderer) WithAttentionColors(fill, text string) *FlowRenderer

+ func (r *FlowRenderer) WithErrorColors(fill, text string) *FlowRenderer

+ func (r *FlowRenderer) WithLeftRight() *FlowRenderer

+ func (r *FlowRenderer) WithLinks(paramName string) *FlowRenderer

+ func (r *FlowRenderer) WithPrimaryColors(fill, text string) *FlowRenderer

+ func (r *FlowRenderer) WithSecondaryColors(fill, text string) *FlowRenderer

+ func (r *FlowRenderer) WithTitle(text string) *FlowRenderer

+ func (r *FlowRenderer) WithTopDown() *FlowRenderer

+ type FlowStep struct

+ Attempt int

+ Changes map[string]any

+ CreatedAt time.Time

+ Error string

+ InterruptPayload map[string]any

+ NextKey string

+ PredecessorID int

+ PrevKey string

+ StartedAt time.Time

+ State map[string]any

+ Status string

+ StepDepth int

+ StepID int

+ StepKey string

+ SubHistory []FlowStep

+ SubWorkflowName string

+ Subgraph bool

+ SuccessorID int

+ TaskName string

+ UpdatedAt time.Time

+ func (s FlowStep) Duration() time.Duration

+ func (s FlowStep) HasStarted() bool

+ type FlowSummary struct

+ CancelReason string

+ CreatedAt time.Time

+ Error string

+ FairnessKey string

+ FlowKey string

+ Priority int

+ StartedAt time.Time

+ Status string

+ TaskName string

+ ThreadKey string

+ UpdatedAt time.Time

+ WorkflowName string

+ func (f FlowSummary) Duration() time.Duration

+ type Graph struct

+ func NewGraph(name string) *Graph

+ func (g *Graph) AddTask(name, url string)

+ func (g *Graph) AddTransition(from, to string)

+ func (g *Graph) AddTransitionForEach(from, to string, forEach string, as string)

+ func (g *Graph) AddTransitionGoto(from, to string)

+ func (g *Graph) AddTransitionOnError(from, to string)

+ func (g *Graph) AddTransitionSwitch(from, to string, when string)

+ func (g *Graph) AddTransitionWhen(from, to string, when string)

+ func (g *Graph) Annotate(name string, note string)

+ func (g *Graph) Annotation(name string) string

+ func (g *Graph) EntryPoint() string

+ func (g *Graph) ErrorTransition(name string) (Transition, bool)

+ func (g *Graph) FanInFor(fanOutSource string) string

+ func (g *Graph) HasFanIn() bool

+ func (g *Graph) IsFanIn(name string) bool

+ func (g *Graph) IsFanOutSource(name string) bool

+ func (g *Graph) MarshalJSON() ([]byte, error)

+ func (g *Graph) Name() string

+ func (g *Graph) NamesForURL(url string) []string

+ func (g *Graph) Nodes() []Node

+ func (g *Graph) Reducers() map[string]Reducer

+ func (g *Graph) SetEntryPoint(name string)

+ func (g *Graph) SetFanIn(name string)

+ func (g *Graph) SetReducer(field string, reducer Reducer)

+ func (g *Graph) Transitions() []Transition

+ func (g *Graph) URLOf(name string) string

+ func (g *Graph) UnmarshalJSON(data []byte) error

+ func (g *Graph) Validate() error

+ type GraphRenderer struct

+ func NewGraphRenderer(g *Graph) *GraphRenderer

+ func (r *GraphRenderer) Render() (string, error)

+ func (r *GraphRenderer) WithAnnotationColor(color string) *GraphRenderer

+ func (r *GraphRenderer) WithLeftRight() *GraphRenderer

+ func (r *GraphRenderer) WithLinks(paramName string) *GraphRenderer

+ func (r *GraphRenderer) WithPrimaryColors(fill, text string) *GraphRenderer

+ func (r *GraphRenderer) WithSecondaryColors(fill, text string) *GraphRenderer

+ func (r *GraphRenderer) WithTitleLabel(show bool) *GraphRenderer

+ func (r *GraphRenderer) WithTopDown() *GraphRenderer

+ type Node struct

+ Name string

+ URL string

+ type Query struct

+ Cursor string

+ FairnessKey string

+ Limit int

+ NewerThan time.Duration

+ OlderThan time.Duration

+ Priority int

+ Search string

+ Shard int

+ Status string

+ TaskName string

+ ThreadKey string

+ WorkflowName string

+ type RawFlow struct

+ func NewRawFlow() *RawFlow

+ func (f *RawFlow) ClearChanges()

+ func (f *RawFlow) ClearControl()

+ func (f *RawFlow) RawChanges() map[string]any

+ func (f *RawFlow) RawState() map[string]any

+ func (f *RawFlow) SetAttempt(attempt int)

+ func (f *RawFlow) SetInterruptResolution(resumeData map[string]any)

+ func (f *RawFlow) SetRawChanges(changes map[string]any)

+ func (f *RawFlow) SetRawState(state map[string]any)

+ func (f *RawFlow) SetSubgraphResolution(result map[string]any, errStr string)

+ func (f *RawFlow) SetTimestamps(createdAt, updatedAt time.Time)

+ type Reducer string

+ const ReducerAdd

+ const ReducerAnd

+ const ReducerAppend

+ const ReducerConcat

+ const ReducerMax

+ const ReducerMerge

+ const ReducerMin

+ const ReducerOr

+ const ReducerReplace

+ const ReducerUnion

+ func (r Reducer) Reduce(existing, incoming any) (any, error)

+ type Transition struct

+ As string

+ ForEach string

+ From string

+ OnError bool

+ Switch bool

+ To string

+ When string

+ WithGoto bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL