interfaces

Documentation

Index

• func GenerateInterfaces(clients []any, dir string, opts ...Option) error
• func MethodHasAnyPrefix(m reflect.Method, prefixes []string) bool
• func MethodHasAnySuffix(m reflect.Method, suffixes []string) bool
• type Option
  • func WithIncludeFunc(f func(reflect.Method) bool) Option
• type Options
  • func (o *Options) SetDefaults()

Functions

func GenerateInterfaces

func GenerateInterfaces(clients []any, dir string, opts ...Option) error

GenerateInterfaces generates service interfaces to be used for generating mocks. The clients passed in as the first argument should be structs that will be used to generate the service interfaces. The second argument, dir, is the path to the output directory where the service interface files will be created.

func MethodHasAnyPrefix

func MethodHasAnyPrefix(m reflect.Method, prefixes []string) bool

MethodHasAnyPrefix returns true if the method name has any of the given prefixes.

func MethodHasAnySuffix

func MethodHasAnySuffix(m reflect.Method, suffixes []string) bool

MethodHasAnySuffix returns true if the method name has any of the given suffixes.

Types

type Option

type Option func(*Options)

func WithIncludeFunc

func WithIncludeFunc(f func(reflect.Method) bool) Option

type Options

type Options struct {
	// ShouldInclude tests whether a method should be included in the generated interfaces. If it returns true,
	// the method will be included. MethodHasPrefix and MethodHasSuffix can be used inside a custom function here
	// to customize the behavior.
	ShouldInclude func(reflect.Method) bool
}

func (*Options) SetDefaults

func (o *Options) SetDefaults()