exampleutil

package
v0.10.0 Latest Latest
Warning

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

Go to latest
Published: Apr 25, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExportProcessors

func ExportProcessors()

ExportProcessors exports the processors to the specs directory.

func RunExample

func RunExample(p sdk.Processor, e Example)

RunExample runs the given example with the given processor and logs the result. It is intended to be used in example functions. Additionally, it stores the processor specification and example in a global map so it can be used to generate documentation.

Types

type Example

type Example struct {
	// Order is an optional field that is used to order examples in the
	// documentation. If omitted, the example will be ordered by description.
	Order       int                 `json:"-"`
	Summary     string              `json:"summary"`
	Description string              `json:"description"`
	Config      map[string]string   `json:"config"`
	Have        opencdc.Record      `json:"have"`
	Want        sdk.ProcessedRecord `json:"want"`
}

Jump to

Keyboard shortcuts

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