module

Documentation

Index

• type Exports
• type ModuleComponent
  • func NewModuleComponent(o component.Options) (*ModuleComponent, error)
  • func (c *ModuleComponent) CurrentHealth() component.Health
  • func (c *ModuleComponent) LoadFlowContent(args map[string]any, contentValue string) error
  • func (c *ModuleComponent) RunFlowController(ctx context.Context)

Types

type Exports

type Exports struct {
	// Exports exported from the running module.
	Exports map[string]any `river:"exports,block"`
}

Exports holds values which are exported from the run module.

type ModuleComponent

type ModuleComponent struct {
	// contains filtered or unexported fields
}

ModuleComponent holds the common properties for module components.

func NewModuleComponent

func NewModuleComponent(o component.Options) (*ModuleComponent, error)

NewModuleComponent initializes a new ModuleComponent.

func (*ModuleComponent) CurrentHealth

func (c *ModuleComponent) CurrentHealth() component.Health

CurrentHealth contains the implementation details for CurrentHealth in a module component.

func (*ModuleComponent) LoadFlowContent

func (c *ModuleComponent) LoadFlowContent(args map[string]any, contentValue string) error

LoadFlowContent loads the flow controller with the current component content. It will set the component health in addition to return the error so that the consumer can rely on either or both.

func (*ModuleComponent) RunFlowController

func (c *ModuleComponent) RunFlowController(ctx context.Context)

RunFlowController runs the flow controller that all module components start.