lifecycle

package module

Go to main page

Versions in this module

v1

v1.7.2

Feb 26, 2026

Changes in this version

+ func NewProcessCmd(ctx context.Context, name string, args ...string) *proc.Cmd

v1.7.1

Feb 23, 2026

v1.7.0

Feb 21, 2026

v1.6.5

Feb 21, 2026

Changes in this version

+ func StopAndWait(ctx context.Context, w Worker) error

+ type ProcessWorker = worker.ProcessWorker

+ type WebhookOption = events.WebhookOption

+ func WithMaxPayloadBytes(n int64) WebhookOption

+ type WebhookSource = events.WebhookSource

v1.6.4

Feb 18, 2026

v1.6.3

Feb 18, 2026

v1.6.2

Feb 17, 2026

v1.6.1

Feb 17, 2026

v1.6.0

Feb 17, 2026

Changes in this version

type GoOption

+ func WithStackCapture(enabled bool) GoOption

+ type SignalContext = signal.Context

v1.5.2

Feb 16, 2026

v1.5.1

Feb 15, 2026

v1.5.0

Feb 15, 2026

Changes in this version

+ const RestartAlways

+ const RestartNever

+ const RestartOnFailure

+ const SupervisorStrategyOneForAll

+ const SupervisorStrategyOneForOne

+ const WorkerEnvPrevExit

+ const WorkerEnvResumeID

+ const WorkerStatusCreated

+ var DefaultRouter = events.DefaultRouter

+ var ErrNotHandled = events.ErrNotHandled

+ func Dispatch(ctx context.Context, e Event)

+ func DoDetached(parent context.Context, fn func(ctx context.Context) error) error

+ func GetForceExitThreshold(ctx context.Context) int

+ func GetObserver() observe.Observer

+ func Handle(pattern string, handler Handler)

+ func HandleFunc(pattern string, handler func(context.Context, Event) error)

+ func IsUnsafe(ctx context.Context) bool

+ func LifecycleDiagramConfig() *introspection.DiagramConfig

+ func NewInteractiveRouter(opts ...InteractiveOption) *events.Router

+ func NewNoOpLogger() *slog.Logger

+ func NewWebhookSource(addr string) *events.WebhookSource

+ func Receive[V any](ctx context.Context, ch <-chan V) iter.Seq[V]

+ func ResetSignalCount(ctx context.Context)

+ func SetMetricsLabelPolicy(p *metrics.LabelPolicy)

+ func SetObserver(o observe.Observer)

+ func Shutdown(ctx context.Context)

+ func ShutdownAndWait(ctx context.Context)

+ func Signal(ctx context.Context) os.Signal

+ func Start(ctx context.Context) error

+ func Wait(ctx context.Context)

+ func WithCancelOnInterrupt(enabled bool) signal.Option

+ func WithInputCommands(commands ...string) events.InputOption

+ func WithInputHandlers(handlers map[string]events.Handler) events.InputOption

+ func WithLogger(l *slog.Logger) any

+ func WithMetrics(p metrics.Provider) any

+ func WithResetTimeout(d time.Duration) signal.Option

+ func WithRouterHandlers(handlers map[string]events.Handler) events.RouterOption

+ func WithShutdownTimeout(d time.Duration) any

+ type BaseWorker = worker.BaseWorker

+ func NewBaseWorker(name string) *BaseWorker

+ type ChannelSource = events.ChannelSource

+ func NewChannelSource(ch <-chan Event) *ChannelSource

+ type ClearLineEvent = events.ClearLineEvent

+ type Escalator = events.Escalator

+ func NewEscalator(primary Handler, fallback Handler) *Escalator

+ type Event = events.Event

+ type FileWatchSource = events.FileWatchSource

+ func NewFileWatchSource(path string) *FileWatchSource

+ type GoOption = runtime.GoOption

+ func WithErrorHandler(h func(error)) GoOption

+ type Group struct

+ func NewGroup(ctx context.Context) (*Group, context.Context)

+ func (g *Group) Go(fn func(ctx context.Context) error)

+ func (g *Group) SetLimit(n int)

+ func (g *Group) Wait() error

+ type Handler = events.Handler

+ func NewReloadHandler(onReload func(context.Context) error) Handler

+ func NewShutdownFunc(fn func()) Handler

+ func NewShutdownHandler(cancel context.CancelFunc) Handler

+ func NewTerminateHandler(suspend Handler, shutdown Handler, opts ...TerminateOption) Handler

+ func WithFixedEvent(h Handler, ev Event) Handler

+ func WithStateCheck(h Handler, checker StateChecker) Handler

+ type HandlerFunc = events.HandlerFunc

+ type HealthCheckSource = events.HealthCheckSource

+ func NewHealthCheckSource(name string, check events.CheckFunc, opts ...HealthOption) *HealthCheckSource

+ type HealthOption = events.HealthOption

+ func WithHealthInterval(d time.Duration) HealthOption

+ func WithHealthStrategy(strategy events.TriggerStrategy) HealthOption

+ type InputEvent = events.InputEvent

+ type InputOption = events.InputOption

+ func WithInputMapping(key string, event events.Event) InputOption

+ func WithInputMappings(mappings map[string]events.Event) InputOption

+ func WithInputReader(r io.Reader) InputOption

+ func WithRawInput(handler func(line string)) InputOption

+ type InputSource = events.InputSource

+ func NewInputSource(opts ...InputOption) *InputSource

+ type InteractiveOption func(*interactiveConfig)

+ func WithCommand(name string, handler events.Handler) InteractiveOption

+ func WithDefaultHandler(handler events.Handler) InteractiveOption

+ func WithDefaultMappings() InteractiveOption

+ func WithInput(enable bool) InteractiveOption

+ func WithInputBackoff(d time.Duration) InteractiveOption

+ func WithInputBufferSize(size int) InteractiveOption

+ func WithInputEventBuffer(size int) InteractiveOption

+ func WithInputOptions(opts ...events.InputOption) InteractiveOption

+ func WithInterruptHandler(handler events.Handler) InteractiveOption

+ func WithShutdown(fn func()) InteractiveOption

+ func WithSignal(enable bool) InteractiveOption

+ func WithSuspendOnInterrupt(h events.Handler) InteractiveOption

+ func WithUnknownHandler(handler events.Handler) InteractiveOption

+ type InterruptEvent = events.InterruptEvent

+ type LineEvent = events.LineEvent

+ type NoOpObserver = observe.NoOpObserver

+ type Observer = observe.Observer

+ type ResumeEvent = events.ResumeEvent

+ type Router = events.Router

+ func NewRouter(opts ...RouterOption) *Router

+ type RouterOption = events.RouterOption

+ type Runnable = runtime.Runnable

+ func Job(fn func(context.Context) error) Runnable

+ type ShutdownEvent = events.ShutdownEvent

+ type SignalOption = signal.Option

type SignalState

+ func GetSignalState(ctx context.Context) (SignalState, bool)

+ type Source = events.Source

+ func NewOSSignalSource(signals ...os.Signal) Source

+ func NewTickerSource(interval time.Duration) Source

+ type StateChecker = events.StateChecker

+ type SupervisorRestartPolicy = supervisor.RestartPolicy

+ type SuspendEvent = events.SuspendEvent

+ type SuspendHandler = events.SuspendHandler

+ func NewSuspendHandler() *SuspendHandler

+ type SuspendManager = suspend.Manager

+ func NewSuspendManager() *SuspendManager

+ type Suspendable = worker.Suspendable

+ type SuspendableHandler = events.SuspendableHandler

+ type Task = runtime.Task

+ func Go(ctx context.Context, fn func(context.Context) error, opts ...GoOption) Task

+ type TerminateEvent = events.TerminateEvent

+ type TerminateOption = events.TerminateOption

+ func WithContinueOnFailure(continueOnFailure bool) TerminateOption

+ type TickEvent = events.TickEvent

+ type UnknownCommandEvent = events.UnknownCommandEvent

v1.4.1

Feb 1, 2026

v1.4.0

Feb 1, 2026

Changes in this version

+ func Do(parent context.Context, fn func(ctx context.Context)) error

+ func OnShutdown(ctx context.Context, fn func())

+ func Run(fn func(context.Context) error, opts ...Option) error

+ func Sleep(ctx context.Context, d time.Duration) error

v1.3.1

Jan 31, 2026

Changes in this version

+ type SupervisorBackoff = supervisor.Backoff

type Worker

+ func NewWorkerFromFunc(name string, fn func(context.Context) error) Worker

v1.3.0

Jan 31, 2026

Changes in this version

+ const EnvPrevExit

+ const EnvResumeID

+ const StrategyOneForAll

+ const StrategyOneForOne

+ const WorkerStatusFailed

+ const WorkerStatusPending

+ const WorkerStatusRunning

+ const WorkerStatusStopped

+ func SignalStateDiagram(s SignalState) string

+ func SystemDiagram(sig SignalState, work WorkerState) string

+ func WorkerStateDiagram(s WorkerState) string

+ func WorkerTreeDiagram(s WorkerState) string

+ type Container = container.Container

+ func NewMockContainer(id string) Container

+ type ContainerStatus = container.Status

+ type Context = signal.Context

+ type Option = signal.Option

+ type SignalState = signal.State

+ type Supervisor = supervisor.Supervisor

+ func NewSupervisor(name string, strategy SupervisorStrategy, specs ...SupervisorSpec) Supervisor

+ type SupervisorFactory = supervisor.Factory

+ type SupervisorSpec = supervisor.Spec

+ type SupervisorStrategy = supervisor.Strategy

+ type Worker = worker.Worker

+ func NewContainerWorker(name string, c Container) Worker

+ func NewProcessWorker(name string, nameCmd string, args ...string) Worker

+ type WorkerState = worker.State

+ type WorkerStatus = worker.Status

v1.2.0

Jan 29, 2026

Changes in this version

+ func Mermaid(s State) string

+ func WithHookTimeout(d time.Duration) signal.Option

+ type State = signal.State

v1.1.0

Jan 29, 2026

Changes in this version

+ func BlockWithTimeout(done <-chan struct{}, timeout time.Duration) error

+ func NewLogMetricsProvider() metrics.Provider

+ func SetLogger(l *slog.Logger)

+ func SetMetricsProvider(p metrics.Provider)

+ func SetStrictMode(strict bool)

+ func StartProcess(cmd *exec.Cmd) error

+ func WithForceExit(threshold int) signal.Option

+ func WithInterrupt(cancel bool) signal.Option

v1.0.0

Jan 26, 2026

v0

v0.1.1

Jan 26, 2026

Changes in this version

+ func UpgradeTerminal(r io.Reader) (io.Reader, error)

v0.1.0

Jan 26, 2026

Changes in this version

+ var Version string

+ func IsInterrupted(err error) bool

+ func NewInterruptibleReader(base io.Reader, cancel <-chan struct{}) *termio.InterruptibleReader

+ func NewSignalContext(parent context.Context) *signal.Context

+ func OpenTerminal() (io.ReadCloser, error)

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