module

package
v0.36.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

Directories

Path Synopsis
git
Package git implements the module.git component.
Package git implements the module.git component.

Jump to

Keyboard shortcuts

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