base

Documentation

Index

• Variables
• func Module(name, description string, author []string, usage string, ...) api.Module
• func NewPipeBuilder(must, optional map[string]reflect.Kind, ...) api.PipeBuilder
• func NewState() api.State
• func Preprocessor(regex string, exec func(map[string]interface{}, string) (api.State, error)) api.Preprocessor

Variables

var NotFoundError = errors.New("no content found")

Functions

func Module

func Module(name, description string, author []string, usage string, preprocessor api.Preprocessor, pipes map[string]api.PipeBuilder) api.Module

func NewPipeBuilder

func NewPipeBuilder(must, optional map[string]reflect.Kind, builder func(args map[string]interface{}) (api.Pipe, api.PipeBuildError)) api.PipeBuilder

func NewState

func NewState() api.State

func Preprocessor

func Preprocessor(regex string, exec func(map[string]interface{}, string) (api.State, error)) api.Preprocessor

*

• base.Preprocessor is a regular expression based preprocessor
• It uses a regex string and an execute function as input *
• The function will not throw an error unless the regexp is invalid