checker

Documentation

Index

• func UseSetup(ctx context.Context, cfg *config.Config) error
• func UseableEnv(ctx context.Context, cfg *config.Config) error
• type Checker
  • func New(opts ...Opt) Checker
• type Func
• type Opt
  • func WithChecks(funcs ...Func) Opt
• type Opts
  • func (o *Opts) Configure(opts ...Opt)

Functions

func UseSetup

func UseSetup(ctx context.Context, cfg *config.Config) error

UseSetup is a check to see if the setup is useable.

func UseableEnv

func UseableEnv(ctx context.Context, cfg *config.Config) error

UseableEnv is a check to see if the environment is useable.

Types

type Checker

type Checker interface {
	Check(context.Context, *config.Config) error
}

Checker is the interface for the checker to implement. This checks the configuration for correctness.

func New

func New(opts ...Opt) Checker

New ...

type Func

type Func func(context.Context, *config.Config) error

Func is a function to check the configuration

type Opt

type Opt func(*Opts)

Opt is a functional option for the checker

func WithChecks

func WithChecks(funcs ...Func) Opt

WithChecks ...

type Opts

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

Opts are the options for the checker

func (*Opts) Configure

func (o *Opts) Configure(opts ...Opt)

Configure is a method to apply multiple options