config

package
v0.0.0-...-41476ae Latest Latest
Warning

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

Go to latest
Published: Oct 8, 2022 License: MIT Imports: 1 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshals it into a Struct.
	//
	// func (s *JobsService) Init(cp config.Configurer) error {
	//     s.config := &JobsConfig{}
	//     if err := cp.UnmarshalKey("jobs", s.config); err != nil {
	//         return err
	//     }
	// }
	UnmarshalKey(name string, out any) error

	// Unmarshal unmarshal the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(out any) error

	// Overwrite used to overwrite particular values in the unmarshalled config
	Overwrite(values map[string]any) error

	// Get used to get config section
	Get(name string) any

	// Has checks if config section exists.
	Has(name string) bool

	// GetVersion returns app version
	GetVersion() string

	// GetCmd returns cli command name
	GetCmd() string

	// GracefulTimeout represents timeout for all servers registered in endure
	GracefulTimeout() time.Duration
}

Jump to

Keyboard shortcuts

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